CodeMeter AdminManual En
CodeMeter AdminManual En
All rights reserved. No part of this documentation, the accompanying software, or other components of the described product may be
reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any
purpose other than the personal use of the purchaser without the express written permission of Wibu-Systems.
While the data contained in this document has been written with all due care, Wibu-Systems does not warrant or assume
responsibility or represent that the data is free from errors or omissions.
Wibu-Systems expressly reserves the right to change programs or this documentation without prior notice.
Wibu-Systems®, CodeMeter®, SmartShelter®, SmartBind® and Blurry Box® are registered trademarks of Wibu-Systems. All other
brand names and product names used in this documentation are trade names, service marks, trademarks, or registered trademarks of
their respective owners.
Table of Contents
I Manual 5
1 Version ...........................................................................................................5
2 First important Information ...........................................................................................................5
3 Safety Instructions ...........................................................................................................7
4 Installation ...........................................................................................................8
4.1 Installing on 32/64-bit Windows ............................................................................................................................8
...........................................................................................................33
7 Importing and Updating Licenses
7.1 The CmFAS Assistant in CodeMeter Control Center
............................................................................................................................34
...........................................................................................................96
9 CmDust (CodeMeter Enduser Support Tool)
10 CMU - CodeMeter Universal...........................................................................................................98
Support Tool
...........................................................................................................104
11 CodeMeter License Tracking
11.1 Requirements and Configuration ............................................................................................................................104
...........................................................................................................114
13 Open Source Software used in the products CodeMeter 7.20b, CodeMeter Protection Suite 10.70b, CodeMeter Embe
II Glossary 115
Index 118
4
M anual
1 Manual
The following parts of this CodeMeter Developer Guide on installing and using many of the CodeMeter tools are also of interest for
the administrator and thus part of a separate section.
1.1 Version
CodeMeter User Help 7.20b, 4/30/2021.
Copyright © 2007-2021
by WIBU-SYSTEMS AG, Karlsruhe / Germany
All rights reserved.
Wibu-Systems contact information:
Addre ss: WIBU-SYS T EMS AG
Rue ppurre r Strass e 52-54
D-76137 Karlsruhe , Ge rmany
P h on e : +49 (0)-721-93172-0
Inte rn e t: h ttps://www.wibu.com
E-mail: [email protected]
With Cm D ongles with additional flash m emory it can happen that the Windows m essage "Do you want to scan and fix
'XYZ'?" displays.
This always happens when the connection was disconnected during access and the write process was not completed by
closing a special flag at the sam e tim e.
Solution:
· Using the safely remove option, always log off the Cm D ongle before removing it from the system.
· Click on "Scan and fix". Pl eas e save all important data first!
Alternatively to the mass storage device status, Cm D ongles can also display as HID (Human Interface Device) without a drive status
(for more details see here 110).
Cm D ongles without Flash m emory represent virtual drives, i.e. data you save on it will get lost once you disconnect the
Cm D ongle !
By default, CodeMeter License Serv er is installed as service (Windows) or as daemon (Linux, macOS) and thus automatically starts on
system startup. The behavior at system startup is optimized by using default values and prevents eventually occurring process access
conflicts. In the case of problems, please contact Wibu-Systems Support.
If CodeMeter License Serv er should not be active, it can be manually started or stopped 25 . The following table shows you start
options for different operating systems.
is registered as a Windows service and can be started with user privileges. For stopping the service,
CodeMeter License Serv er
however, you need administrator privileges under Windows (System Settings | Managem ent | Services).
Ope rating Syste m Me nu Control N ame
[Start | All Programs | Cod e Me te r | Cod e Me te r Control Ce nte r] CodeMeter.exe
Windows
Pre ss "Windows" k e y to ope n Start scree n | T ype "Cod e Me te r Control
Ce nte r" | Pre ss "Ente r" k e y
[Programs | Cod e Me te r | Cod e Me te r Control Ce nte r CodeMeterMacX
macOS
[Applications | Syste m | Cod e Me te r Control Ce nte r] or [Applications | CodeMeterLin
Linux Acce ssorie s | Cod e Me te r Control Ce nte r]
On Linux (graphic desktop environm ent KDE 4) eventually connected Cm Sticks/BMC / Cm Cards are not automatically detected.
If removable devices are connected to Linux systems, they have to be mounted, i.e. making the filesystem on the device
accessible. Som e desktop environm ents do this automatically, som e do not.
Check the settings for general automatic mounting and also for the Cm Stick/BMC / Cm Card using the m enu item "System
Settings | Hardware | Removable Devices".
5
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Of course you cannot mount a file system whose underlying device is not connected.
Please make sure you activate a Cm ActLicense license only on the PC for which you want to use the license.
Before you are able to activate Cm ActLicense licenses for your PC you require a separate file you obtain from your software vendor.
This licenses information file corresponds to an empty license container. It serves to collect hardware properties of your PC as a kind
of 'finger print' for the subsequent activation. Please proceed as follows:
1. Drag & drop the *.wbb file, e.g. MyCmActLicense.wbb, you received from your software vendor onto CodeMeter Control
Center.
The "Status" fi eld s h ows th at is fil e is only an empty licens e contain er and not a licens e. At the sam e tim e, the CodeMeter
6
M anual
First im p ortant Inform ation
The "Status"field shows that the license has been activated. At the sam e tim e, the license has a serial number, and the
CodeMeter symbol has switched to activated status.
Cod eM eter FAQ
A comprehensive FAQ area on CodeMeter and on other additional products, you will find at our CodeMeter support page.
Please take a first look at the information on the CodeMeter support page before you contact our support team. In most cases, you
will find quick answers to your questions and problems.
Sup p ort
7
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
1.4 Installation
The following section contains installing and uninstalling information of the CodeMeter for different operating systems.
While installing it is not required that a Cm D ongle is connected to the computer.
· Windows 32-bit/64-bit 8
· macOS 10
· Linux 12
On installing 8 it can be decided whether CodeMeter License Serv er is set up as a server in a network environm ent and the related
TCP port 8 22350 is registered with the Windows firewall. By default, CodeMeter License Serv er is only available locally (local host).
Also during the installation an automatic search of network servers is set as default. This is implem ented by a broadcast via UDP
(User Datagram Protocol) (it is listened only at server search tim e and only until the end of the UDP Waiting Tim e) and for
communication the related UDP port 8 22350 is registered with the Windows firewall.
In order to modify these default settings open the installation wizard again. In the following dialog click the button
"Change" to allow the modifiactions to be made.
9
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
File D e scription
CodeMeterCC.exe Proce ss o f CodeMeter Control Center
CodeMeterCC**.qm Languag e file s for CodeMeter Control Center
cmu32(64).exe Proce ss o f cmu commandlin e program
CmRmtAct32(64).dll Dynamic Link Library (DLL) req uire d by CodeMeter.exe for lice ns e update .
CmRmtAct32(64).l** Languag e file s for lice ns e update .
CmWebAdmin.exe CodeMeter WebAdmin in s e ve ral languag e s.
WibuCm32(64).dll Includ e s all CodeMeter API functions. Th is DLL must b e installe d on all PCs using a CodeMeter
prote cte d application ; installation path :[\Windows\System32 ].
WibuCm32(64).lXX Languag e file s for WibuCm32(64).dll ; installation path :[\Windows\System32] .
WibuCmTrigger32(64).dll Req uire d by Microso ft Inte rn e t Explore r.
WibuCmTrigger32(64).lXX Languag e file s for WibuCmTrigger32(64).dll .
CmUserhelp\*.* CodeMeter onlin e he lp in s e ve ral languag e s ; installation pat h [%CodeMeter%
\Runtime\help ].
1.4.1.2 Uninstalling on 32/64-bit Windows
1. Select the "Software" option in the Windows System control start m enu item.
2. Select the "CodeM eter Runtime Kit" item and the "Remove" option
All CodeMeter files as part of an installations package and registry entries are deleted. Only the log and backup directories remain.
1.4.2 Installing on macOS
For macOS a CodeMeter Runtim e Kit installation programm is available:
File D e scription
CmRuntimeUser.dmg installs all req uire d CodeMeter runtime compon e nts
1. Run the CmRuntimeUser.dmg file to install the CodeMeter Runtim e Kit.
2. Select the file CmInstall.mpkg in the new directory CmRuntime and follow the instructions of the installation wizard.
1.4.2.1 Installed files on macOS
For macOS the following directory structure is valid:
.
|____usr
| |____local
| |____bin
| |____cmu
|____Library
| |____Application Support
| | |____CodeMeter
| | |____Backup
| | |____CmAct
| | |____CmCloud
| |____Preferences
| | |____com.wibu.CodeMeter.Server.ini
| |____Java
| | |____Extensions
| | |____libwibucmJNI.jnilib
| | |____libwibucmJNI.dylib
| | |____libwibuxpm4j.dylib
| | |____libwibuxpm4j.jnilib
| |____Logs
| | |____CodeMeter
| |____PreferencePanes
| | |____CodeMeter.prefPane
| | |____Contents
| | |_____CodeSignature
| | | |____CodeResources
| | |____MacOS
| | | |____CodeMeter
| | |____Resources
| | | |____English.lproj
| | | | |____AddServer.nib
| | | | |____Localizable.strings
10
M anual
Installation
| | | | |____InfoPlist.strings
| | | | |____CodeMeterPref.nib
| | | |____CodeMeter.icns
| | | |____German.lproj
| | | | |____AddServer.nib
| | | | |____Localizable.strings
| | | | |____InfoPlist.strings
| | | | |____CodeMeterPref.nib
| | | |____French.lproj
| | | | |____AddServer.nib
| | | | |____Localizable.strings
| | | | |____InfoPlist.strings
| | | | |____CodeMeterPref.nib
| | | |____CodeMeterPref.tiff
| | | |____Japanese.lproj
| | | |____AddServer.nib
| | | |____Localizable.strings
| | | |____InfoPlist.strings
| | | |____CodeMeterPref.nib
| | |____Info.plist
| |____Frameworks
| | |____WibuCmMacX.framework
| | |____Resources
| | |____Versions
| | | |____A
| | | | |_____CodeSignature
| | | | | |____CodeResources
| | | | |____Resources
| | | | | |____Info.plist
| | | | |____WibuCmMacX
| | | |____Current
| | |____WibuCmMacX
| |____LaunchDaemons
| |____com.wibu.CodeMeter.WebAdmin.plist
| |____com.wibu.CodeMeter.Server.plist
|____Applications
|____CodeMeter.app
|____CmUserHelp
| |_____…
|____Contents
|_____CodeSignature
| |____CodeResources
|____MacOS
| |____CodeMeterCC_zh.qm
| |____CodeMeterCC_fr.qm
| |____CodeMeterCC
| |____CodeMeterCC_it.qm
| |____CodeMeterCC_es.qm
| |____CodeMeterMacX
| |____CmWebAdmin
| |____CodeMeterCC_de.qm
| |____CodeMeterCC_ja.qm
| |____CodeMeterCC_ru.qm
|____PlugIns
|____Resources
| |____CodeMeterCC.icns
|____Info.plist
|____PkgInfo
The following table shows an excerpt of installed files:
File D e scription
CodeMeterMacX [Applications/CodeMeter.app] ; CodeMeter License Server proce ss.
CmWebAdmin [Applications/CodeMeter.app] ; CodeMeter WebAdmin in s e ve ral languag e s.
CodeMeterUserhelp [Applications/CodeMeter.app/CmUserHelp] ; CodeMeter e nd us e r he lp
CodeMeterCC [Applications/CodeMeter.app/Contents] ; CodeMeter Control Center.
11
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
File D e scription
CodeMeterCC**.qm [Applications/CodeMeter.app/Contents/resources] ; Languag e file s for
CodeMeter Control Center .
Cmu [usr/bin/cmu] ; cmu commandlin e program.
WibuCmMacX [Library/Frameworks/WibuCmMacX.framework] ; includ e s all CodeMeter API
functions.
CodeMeterMacX [Library/StartupItems] ; CodeMeter License Server startup ite m.
libwibuKJini.jnilib [Library/Java/extensions] ; CodeMeter Java e xte nsion.
com.wibu.CodeMeter.Server.ini [Library/Preferences] ; includ e s "Pro fille Basic S e ttings" for CodeMeterMacX.
CodeMeter.prefPane [System/Library/PreferencePanes] ; includ e s the syste m control for
CodeMeter MacX."
Starting WebAdmin
You start CodeMeter WebAdm in in Mac/Linux:
· using the button Web Admin in CodeM eterGU I tool
· directly in your Intern et brows er speci fying the URLs: http://localhost:22350 or http://127.0.0.1:22350.
1.4.2.2 Uninstalling on macOS
To uninstall the CodeMeterÒ Runtim e Kit, proceed as follows:
1. R e-op en the CmRuntimeUser.dmg disk imag e.
2. Start in the directory CmRunTime the program CmUninstall.mpkg and follow the instructions o f the wizard (in the
| | |-- CodeMeterCC
| | |-- CodeMeterLin
| | |-- CmWebAdmin
| | |-- cmu
| | `-- codemeter-info (permissions -rwsr-xr-x)
| |-- lib (for 64-bit systems here the 64-bit libs locate with suffix 64; otherwise the 32-bit
libs)
| | |-- libWibuCmWebLin[64].so
| | |-- libwibucmJNI[64].so
| | |-- libwibucmlin[64]-4.so
| | `-- libwibucmlin[64].so -> libwibucmlin[64]-4.so
| |-- lib32 (directory exists only in the 64-bit Installer)
| | |-- libWibuCmWebLin.so
| | |-- libwibucmJNI.so
| | |-- libwibucmlin-4.so
| | `-- libwibucmlin.so -> libwibucmlin-4.so
| `-- share
| |-- CodeMeter
| | |-- CodeMeterCC
| | |-- CodeMeterCn.wbb
| | |-- CodeMeterDe.wbb
| | |-- CodeMeterFr.wbb
| | |-- CodeMeterIt.wbb
| | |-- CodeMeterJp.wbb
| | |-- CodeMeterLin
| | |-- CodeMeterUs.wbb
| | |-- WibuCmSTrigger.jar
| | |-- codemeter.rc (copy of /etc/init.d/codemeter)
| | |-- getpath.class
| | `-- libWibuCmWebLin.so -> ../../lib/libWibuCmWebLin.so
| |-- applications
| | `-- codemeter.desktop
| |-- doc
| | `-- CodeMeter
| | |-- AppletExample.class
| | |-- AppletExample.html
| | |-- COPYING
| | |-- CmUserHelp
| | | `-- ...
| | |-- License.rtf
| | `-- README
| |-- man
| | `-- man1
| | `-- codemeter-info.1.gz
| `-- pixmaps
| `-- codemeter.png
`-- var
|-- lib
| `-- CodeMeter
| |-- Backup
| | `-- CM-Backup2-506426-10Aug04-16-40-40.wbb (Sample)
| `-- CmAct
| |-- CmActFI-5010.wbb (Sample)
| `-- 5010_ABCD-4711.wbb (Sample)
`-- log
`-- CodeMeter
`-- CodeMeterLin2010-08-04-170622.log (Sample)
1.4.3.1 Uninstalling on Linux
Execute the respective shell command for uninstalling of the CodeMeterÒ Runtim e Kit:
· for RPM bas ed distributions, such as, Sus e/R edHat/Fedora [rpm - e Cod e Me t e r ]
· for DEB bas ed distributions, such as, Debian/Ubuntu [dpkg -r Cod e Me t e r ]
13
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Please note that extensive problems might occur, if you modify the registry incorrectly. Thus, make sure that you change
values very carefully. For added protection, back up the registry before you modify it. Then, you can restore the registry, if a
problem occurs.
All settings for the administration of the system and all integrated system services and processes are stored here. Many application
programs, such as the Wibu-Systems software, also store their settings here.
In order to check or edit registry entries, please proceed as follows:
1. Open Registry Editor.
In the search box on the task bar, type reg ed it. Then, select the top result for Registry Editor (Desktop app).
Alternatively, press and hold or right-click the Start button, then select Run. Enter regedit in the Op en: box and select OK.
2. Advance to the node [HKEY_LOCAL_MACHINE\SOFTWARE\WIBU-SYSTEMS\CodeMeter\Server\...].
The following values and data types exist:
· REG_DWORD: a binary data typ e in which 32-bit integ er values are stored as 4-byte hexad ecimal values.
· REG_SZ: a string of Unicode characters. For nam es, descriptions, system path s, etc.
You can also create a local Windows CodeMeter.ini file holding the stored settings from the registry.
However, be aware that as soon as CodeMeter License Serv er starts, it checks if a CodeMeter.ini file exists. If there is a
CodeMeter.ini file, all default information from the registry is stored there. From this mom ent on, CodeMeter License Serv er then
will use only the information stored in CodeMeter.ini.
For creating the CodeMeter.ini file, please proceed as follows:
1. Create an empty fil e nam ed CodeMeter.ini in the directory C:\Program Files (x86)\CodeMeter\Runtime\bin.
2. Stop and start the CodeMeter service in CodeMeter Control Center using the "Action | ... " navigation items.
The CodeMeter.ini file is completed.
Changes made are saved only, if the CodeMeter License Serv er service has been stopped before and then restarted after
modifications have been made.
Server.ini file
The settings of applications are stored here in configuration files separately for individual programs in respective directories (*.ini
files).
Changes made are saved only, if the CodeMeter License Serv er daemon has been stopped before and then restarted after
modifications have been made.
On macOS this file locates in:
/Library/Preferences/com.wibu.CodeMeter.Server.ini.
On Linux this file locates in:
/etc/wibu/CodeMeter/Server.ini
In order to check or edit file entries open the file in a text editor of your choice.
1.5.1 General
ActionTimeInterval
specifies the tim e interval the ActionHandler is to scan for an open task to perform.
Value Description
[0, Interval between 0 and 1000 milliseconds (default: 10 milliseconds).
1000]
ApiCommunicationMode
specifies the communication mode between the WibuCm.dll library and CodeMeter License Serv er used by the library.
Modes may be combined.
14
M anual
P rofiling - Cod eM eter License Server setting s
ApiCommunicationMode
Mode Description
1 platform specific (default)
2 shared m emory
4 IPv4
8 IPv6
Platform specific default:
Windows IPv6, IPv4, shared m emory
macOS / IPv6, IPv4
Linux
WinCE IPv4, shared m emory
ApiCommunicationModeServer
specifies the communication mode between the WibuCm.dll library and CodeMeter License Serv er used by CodeMeter License
Serv er.
BindAddress
specifies the IP Address of the network adapter used by CodeMeter License Serv er.
Typical examples are 0.0.0.0 which binds to all network adapter (default) or 192.168.0.1.
BorrowIdentifyByIpAddress
specifies the IP Address (server identification) for a prepared borrowing.
CleanUpTimeOut
contains a tim eout value (in minutes) used by CodeMeter License Serv er to clean up internal handles and threads. The default
value is 120 minutes.
Starting with CodeMeter Version 6.70a this value only affects LAN handles.
CmActPath
contains in the case of applied write filters the location (path information) to which the data of Cm ActLicense is to be saved
persistently. If filters are used your software vendor is likely to inform you.
Please do not mix up this with the location of the default Cm ActLicense read and backup m echanism,
e.g. C:\ProgramData\CodeMeter\CmAct.
This configuration option applies only to Universal Firm Codes and must be explicitely set in conjunction with set write filter
m ethods EWF (Enhanced Write Filter) or FBWF (File Based Write Filter). This is done using the Cm BoxPgm -
Option /lopt:ewffbwf.
15
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
CmActPath
For EWF, please note to select the location on a non-write-protected partition. With FBWF, this can also be an excluded
directory on the partition protected with a write filter.
CmInstanceUid
On starting, CodeMeter License Serv er calculates a unique ID used to discern client computers for station share accesses.
CmWANPort
specifies the port address for the Cm WAN communication used by the server side only. The default value is the port address
22351.
CmWebSocketApi
specifies whether the Cm WebSocket API is used or not.
This entry only affects old versions of the Cm WebSocket API prior to CodeMeter Version 7.10a that do not perform origin
checks.
Origin check
The new Cm WebSocket API from CodeMeter version 7.10a on requires a check for the origin of a request when
information and data is exchanged via Web Components with CodeMeter License Serv er. This is done by a certificate
issued by Wibu-Systems.
At the sam e tim e, old versions of the Cm WebSocket API prior to CodeMeter Version 7.10a due to security reasons are
deactivated by default.
The old versions can be activated by setting the profiling entry CmWebSocketAllowWithoutOriginCheck'='1'. Such
activation, however, is not recomm ended.
If the value 0 (disabled) is set, the online activation in the WebD epot of CodeMeter License Central cannot be used. The Software
Activation Wizard using the CodeMeter License Central Gateways and the file-based activation in WebD epot still work.
Value Description
0 disable
1 enabled (default)
If the value 0 (deactivated) is set, the online activation in WebD epot of CodeMeter License Central cannot be used. However, the
Software Activation Wizard, which uses the CodeMeter License Central Gateways, and the file-based activation in WebD epot still
work.
CmWebSocketAllowWithoutOriginCheck
specifies since CodeMeter Version 7.10a whether the Cm WebSocket API is additionally used without check of the origin of a
request for the Cm WebSocket API or not.
By default, the check is not switched off and is perform ed (0).
For a transition period, it may happen that a not yet completed exchange of web components (WebD epot) may require
activation of the old Cm WebSocket API of a CodeMeter version 7.10a or newer.
Then setting the profiling entry 'CmWebSocketAllowWithoutOriginCheck' to the value '1' after a CodeMeter License
Serv er restart can reactivate the previous Cm WebSocket API with out origin check.
The activation of the old Cm WebSocket API on principle is exp licitly not recom m end ed .
Value Description
0 disable (default)
1 enabled
DisableWebSocketVersions
allows to explicitly disable certain WebSocket protocol versions.
To completely disable the WebSocket interface use DisableWebSocketVersions = 0xFFFFFFFFF.
Optional disabling of a version of the WebSocket API from version 4: DisableWebSocketVersions = <Matching Bit>.
16
M anual
P rofiling - Cod eM eter License Server setting s
DisableWebSocketVersions
This entry is intended for cases in which individual protocol versions should be deactivated for security reasons.
EnabledContainerTypes
specifies the Cm Container Types activated. Currently, four flags are defined which can be bit-wise combined.
This setting is used to avoid technical problems on som e systems.
Value Description
1 Mass Storage (USB mass storage device class)
2 Cm ActLicense
EnableWebAdmin
This param eter is available for embedded systems only ( Linux arm and Big Endian) and is ignored for all other
platforms.
Value Description
0 CodeMeter WebAdm in disabled (default).
1 CodeMeter WebAdm in enabled.
ExePath
specifies the current path information where CodeMeter License Serv er is stored.
On any start, CodeMeter License Serv er saves this path to the param eter allowing applications calling CodeMeter on request to
start CodeMeter License Serv er.
HostNameResolveTimeout
specifies in milliseconds the maximum value of the tim eout that is used to resolve the IP address to the host nam e.
This is used for optimization and adaptation to specific network properties.
The default value is 10 milliseconds. The value can also be set to a value between 0 and 0xffffffffffff (49 days)
milliseconds.
HelpFile
specifies the complete path information and file nam e of the CodeMeter online help file.
IsCmWANServer
specifies whether CodeMeter License Serv er is running as a Cm WAN server or not.
Value Description
0 CodeMeter License Serv er as Cm WAN s erver disabl ed (d efault).
IsNetworkServer
specifies whether CodeMeter License Serv er is running as a network server on the network or not.
Value Description
0 CodeMeter License Serv er as n etwork s erver on the n etwork disabl ed (d efault).
LastLogCleanup
specifies when all CodeMeter *.log files have been deleted using a tim e stamp value.
17
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
LogCleanupTimeout
specifies how long the tim eout value is for the log file deletion. The default value is 336 hours, i.e. 14 days.
LogCmActDiag
specifies whether Cm ActLicense diagnostic logging is activated or not.
Value Description
0 Cm ActLicense diagnostic logging disabl ed.
Logging
specifies whether logging of the console or GUI output is activated or not.
Value Description
0 Logging disabled (default).
1 Logging enabled.
LogLicenseTracking
specifies whether license tracking is activated or not.
Value Description
0 License tracking disabled (default).
1 License tracking enabled.
LogLicenseTrackingPath
specifies the location to where the license tracking files are written to.
Default location is a directory "Licensetracking" parallel to the "Logs" directory specified in param eter LogPath 18
.
LogLicenseTrackingLogRotationSizeInMb
[1..3500]
If a license tracking log file exceeds a size of x MB, the rotation starts.
The input range of x is from 1 to 3500 MB.
The default value is 1000 MB.
If the specified value is outside the input range, automatically the default value applies.
LogLicenseTrackingLogRotationTimeInMinutes
[0..525600]
If the oldest entry of a license tracking log file is older than n minutes, the rotation should start.
The default value is 0 hours.
The input range of n is from 0 to 525600 minutes (approx. 1 year).
If the specified value is outside the input range, automatically the default value applies.
LogPath
specifies the location where the log files are written to.
Default location is the directory generated platform dependently by the Installer.
Windows C:\ProgramData\CodeMeter\Backup\Logs
macOS /Library/Application Support/Logs/CodeMeter
Linux /var/log/CodeMeter
LtClientsCleanupTime
specifies the period how long License Transfer client data will be stored.
The tim e is stored in hours to be able to test using small periods. In CodeMeter WebAdm in it is stored in days. The default
setting is 100 days, i.e. 2400 hours.
18
M anual
P rofiling - Cod eM eter License Server setting s
MaxMessageLength
specifies the maximum length of TCP/IP requests in bytes. Default is 64 MB which should be sufficient for all known API calls.
NetworkAccessFsb
specifies whether an access to a Firm Security Box (FSB) entry is allowed via network or not.
Value Description
0 Access to a FSB entry via network is not allowed (default).
1 Access to a FSB entry via network is allowed.
NetworkPort
specifies the network port address for the communication. The default value is the port address 22350.
The port 22350 is registered by Wibu-Systems at IANA (Internet Assigned Numbers Authority) and uniquely assigned for the
CodeMeter communication. For a list o f assign ed ports s ee www.iana.org/assignm ents/port-numb ers.
NetworkTimeout
specifies the TCP/IP network tim eout value.
Values Description
0 No tim eout will be used.
[40, ∞] Interval between minimum value of 40 and ∞ milliseconds (Default: 10 milliseconds).
ProxyPassword
specifies the password of the proxy server of the local network.
This must be set, if authentication is required through proxy or firewall.
Please note, that under Linux, the environm ent variable http_proxy is considered as system proxy. https_proxy is not yet
supported.
ProxyPasswordSecure
specifies the password for authenticated access to the proxy server.
Please note, that under Linux, the environm ent variable http_proxy is considered as system proxy. https_proxy is not yet
supported.
ProxyPort
specifies the port of the proxy server of the local network.
Please note, that under Linux, the environm ent variable http_proxy is considered as system proxy. https_proxy is not yet
supported.
ProxyServer
specifies the nam e of the proxy server of the local network.
Please note, that under Linux, the environm ent variable http_proxy is considered as system proxy. https_proxy is not yet
supported.
ProxyUser
specifies the user nam e of the proxy server of the local network.
This must be set, if authentication is required through proxy or firewall.
Please note, that under Linux, the environm ent variable http_proxy is considered as system proxy. https_proxy is not yet
supported.
StartAlways
specifies whether CodeMeter License Serv er imm ediately starts without any dialog request.
19
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
StartAlways
Value Description
0 CodeMeter License Serv er will not start imm ediately.
1 CodeMeter License Serv er will be started imm ediately (default).
StartDaemon
specifies whether CodeMeter License Serv er will start as daemon on start [Linux only ].
Value Description
0 CodeMeter License Serv er will not start as daemon on startup.
SystemStartThreshold
specifies the threshold value in seconds after Windows start [Windows only ].
If Windows has not been started since the specified value, the param eter StartAlways 19
is handled in a special way (see
WaitForServiceAfterSystemStart 21 ).
TimeServerTimeout
specifies the tim eout for the tim e server request in seconds. The default value is 20.
TimeServerURL1, TimeServerURL2, …
specifies the URL of the tim e sever to update the Certified Time in the Cm Container. The standard installer sets the following default
values:
TimeServerURL1 = cmtime.codemeter.com
TimeServerURL2 = cmtime.codemeter.fr
TimeServerURL3 = cmtime.codemeter.de
TrustedWebSocketOrigins1, TrustedWebSocketOrigins2, ...
sets local exceptions for checking trusted WebSocket Origins.
Supported input formats are IPv4 and IPv6 addresses and port specifications, e.g. "http://localhost:4040",
"http://[2001:db8::1%25eth0]" "https://[2001:db8::1]:4040".
TrustedWebSocketOrigins1 = null
TrustedWebSocketOrigins2 = file://
TrustedWebSocketOrigins3 = http://example.com
TrustedWebSocketOrigins4 = https://example.com
TrustedWebSocketOrigins5 = http://example.com:33
UDPCachingTime
specifies the waiting tim e in seconds after a UDP (User Datagram Protocol) request is retried.
After a UDP search in the network the servers found are stored inside CodeMeter License Serv er for this tim e. The range of the
param eter is [1, 3600]. The default value is 20 seconds.
UDPWaitingTime
specifies the waiting tim e in milliseconds in order to define the period in which a UDP (User Datagram Protocol) request for an
existing CodeMeter License Serv er on the network has to reply.
This is the maximum tim e all other servers can answer to the request. The default value is 1000 milliseconds. The range of this
param eter is [100, 15000].
UseMobileHandling
specifies whether CodeMeter can be used mobile.
If enabled, a protected application and CodeMeter License Serv er can be started from a mobile disk and will terminate when the
last handle of a protected application was released and the protected application has terminated.
Value Description
20
M anual
P rofiling - Cod eM eter License Server setting s
UseMobileHandling
0 CodeMeter Mobile Handling is disabled.
1 CodeMeter Mobil e Handling is enabl ed.
UseMobileVars
specifies whether CodeMeter Mobile variables are used or not.
Value Description
0 CodeMeter Mobil e variabl es are disabl ed and absolute path s remain.
If CodeMeter uses a local CodeMeter.ini 14 file, the following variables will be used:
o $(CODEMETER_HOME) - contains the absolute path of CodeMeter.exe.
o $(CODEMETER_DRIVE) - contains the drive letter of the Cm Stick.
For example, the LogPath 18 may be set to "$(CODEMETER_HOME)\logs".
If set to a value 0, these variables will not be inserted into CodeMeter.ini but the absolute paths remain.
UseSystemProxy
specifies whether CodeMeter applies the system proxy settings or not.
Please note, that under Linux, the environm ent variable http_proxy is considered as system proxy. https_proxy is not yet
supported.
Value Description
0 CodeMeter do es not apply the system proxy s ettings.
UseUmsDA
specifies whether communication between CodeMeter License Serv er and Cm D ongle is direct or file I/O based.
Value Description
0 Communication is based on file I/O.
1 Communication is based on direct access (PassThru) (default).
if the user starting CodeMeter License Serv er has no administrator privileges, then automatically file I/O applies.
WaitForServiceAfterSystemStart
specifies how long after system start CodeMeter.exe waits in seconds. After that, the WibuCm.dll library starts
CodeMeter.exe as an application [Windows only ].
MaxBorrowDuration
specifies the global maximum period a license is blocked by an borrowing server in minutes.
Please note, that Prepared License Borrowing supports only Firm Codes smaller than 6,000,000.
MaxBorrowQuantity
specifies the global maximum number of licenses which can be borrowed from an borrowing server.
Please note, that Prepared License Borrowing supports only Firm Codes smaller than 6,000,000.
1.5.2 AccessControl
Enabled
specifies whether Access Control Lists (ACL), i.e. using global and specific access rules for accessing licenses and reserving license
access for single staff m ember or complete Active Directory groups, are used or not.
Value Description
21
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
ActiveDirectoryUpdateInterval
specifies the interval in minutes that the Active Directory (AD) server request display is updated for user and group information.
Changes to Windows Registry requires CodeMeter License Serv er to be restarted to apply value changes.
Value Description
0 no update intervals defined; disabled.
[1, minimum waiting tim e is 1 minutes, maximum 1440 minutes (1 day) (default is 15 minutes).
1440]
UsersMaximumNumber
specifies the maximum cache limit for the number of Active Directory (AD) server requests of users in the list of license access
permissions. Default value is 10000.
GroupsMaximumNumber
specifies the maximum cache limit for the number of Active Directory (AD) server requests of groups in the list of license access
permissions. Default value is 10000.
1.5.3 Backup
Interval
contains a tim e interval (in hours) when CodeMeter License Serv er should automatically create and save a backup of the
connected Cm D ongle(s).
Value Description
0 Automatic backup disabled
[1, ∞] Automatic backup enabled for specified hours (default is 24 hours).
Path
contains the path of the location where the backup file of the Cm D ongle(s) is to be saved. The default location for backup files
depends on the operating system in use:
Windows C:\ProgramData\CodeMeter\Backup
macOS /Library/Application Support/CodeMeter/Backup
Linux /var/lib/CodeMeter/Backup
<serial_number>
contains a tim e stamp when the last backup of the specified Cm D ongle was created in seconds passed since 01.01.2000.
UpdateCertifiedTime
specifies whether a Certified Time update takes place before a backup is executed.
Value Description
0 Certified Time update disabled (default).
1 Certified Time update enabled.
1.5.4 HTTP
DigestAuthentication
CodeMeter Versions smaller than 6.60:
The param eter specifies, if authentication via "User Nam e / Password" is required to change settings.
Value Description
0 Authentication via "User Nam e / Password" is disabled.
1 Authentication via "User Nam e / Password" is enabled.
22
M anual
P rofiling - Cod eM eter License Server setting s
Port
specifies the port CodeMeter WebAdm in is listening for HTTP requests. The default value is 22352.
PreparedBorrowingConfiguration
specifies that the configuration of Prepared License Borrowing in CodeMeter WebAdm in is enabled or not.
Please note, that Prepared License Borrowing supports only Firm Codes smaller than 6000000.
Value Description
0 Prepared License Borrowing configuration disabled (default).
1 Prepared License Borrowing configuration enabled.
If enabled, the param eters MaxBorrowDuration 21 and MaxBorrowQuantity 21
can be specified.
ReadAuthenticationEnabled
specifies whether a read authentication is required or not.
Value Description
0 Read authentication disabled (default).
If disabled, remote write operations, e.g. changing the configuration from a remote host, are not allowed.
1 Read authentication enabled.
If enabled, the user needs to enter the ReadPassword 23 before being able to see any CodeMeter WebAdm in page.
ReadPassword
contains the password required to be entered, if ReadAuthenticationEnabled 23
is set to a value of 1(enabled).
RemoteRead
specifies whether it is possible to read from a remote host.
Value Description
0 Remote reading is disabled (default).
2 Remote reading is enabled.
UserAuthentication
CodeMeter Versions small er th an 6.60:
UserName
contains the CodeMeter WebAdm in user nam e, if DigestAuthentication 22
has been enabled.
WritePassword
23
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Enabled
specifies whether HTTPS communication is activated or not.
Value Description
0 HTTPS is disabled (default).
1 HTTPS enabled.
Port
specifies the port the CodeMeter WebAdm in is listening for HTTPS requests. The default value is 22353.
PrivateKeyFile
specifies the path to the private key file required for HTTPS communication. The default value is platform dependent:
Windows C:\ProgramData\CodeMeter\WebAdmin\key.pem
Linux /var/lib/CodeMeter/WebAdmin/key.pem
macOS /Library/Application Support/CodeMeter/WebAdmin/key.pem
1.5.6 ServerSearchList
UseBroadcast
specifies whether automatically licenses on servers are searched for, first locally and then in the network (subnet), i.e. whether a
so-called broadcast is perform ed.
Value Description
0 Broadcast disabled.
1 Broadcast enabled (255.255.255.255 is automatically added) (default).
[ServerSearchList\Server2]
Address=185.55.78.6
For WAN servers next to the required "https:\\" IP address also the 'User' and 'Password' credentials are required. The
password will automatically be converted to PasswordSecure.
[ServerSearchList\Server3]
Address=https://my.product.com/cmwantest"
PasswordSecure=****
User=user1
24
M anual
P rofiling - Cod eM eter License Server setting s
1.5.7 TripleModeRedundancy
TmrEnabled
specifies whether Triple Mode Redundancy (TMR) is active or not.
Only to be used in a TMR Server Setup for using a CodeMeter Backend Server.
Value Description
0 disable (default)
1 enable
Please note, that if enabled, at the sam e tim e, local and shared m emory accesses to this CodeMeter instance except for
CodeMeter WebAdm in and CodeMeter Control Center are disabl ed.
Windows
1. N avigate via " to
Win d o ws | C o n tro l P an el | A d m in istrative To o ls | Services" CodeMeter License Server .
2. Rig h t mous e -click and ' Start' or 'Sto p ' the s e rvice .
Alte rnative ly, us e the "A ctio n
28 " me nu o f CodeMeter Control Center .
macOS
1. N avigate via "System p referen ces | O th er " to the CodeMeter icon.
25
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
3. Click the "Sto p Service" or "Start Service" button to stop or start the s e rvice .
1. Call the following script with 'sudo ' root privile g e s to stop the s e rvice :
Linux
/etc/init.d/codemeter stop.
2. Call the following script with 'sudo ' root privile g e s to start the s e rvice :
/etc/init.d/codemeter start or alte rnative ly the command service codemeter start.
CodeMeter License Serv er uses TCP/IP network protocol for communication and the default port 22350. Make sure your
firewall does not block this port. Please make sure that the used IP-Port 22350 is available for CodeMeter .
1.6.1 Structure and Navigation
26
M anual
Cod eM eter Control Center
· Double -click on the CodeMeter or symbols in the in fo are a o f the Windows task bar
· Rig h t mous e -click on the CodeMeter or symbol the re , and subs eq ue ntly s e le ct the "Show" me nu ite m.
The CodeMeter Control Center s e condary me nu (rig h t mous e -click on the CodeMeter symbol) provid e s the additional me nu ite ms:
Ite m D e scription
We bAdmin Starts CodeMeter WebAdmin in the d efault Inte rn e t brows e r.
E je ct all CmDongle (s) Option to sa fe ly disconn e ct CmDongles.
Disable CmDongle Prompt to ins e rt the CmDongle Password.
H e lp Ope ns the CodeMeter he lp.
About S h ows g e n e ral in formation on CodeMeter compon e nts.
Q uit Exits but not s h uts down the s e rvice CodeMeter License Server.
· N avigation by the start me nu ( Pre ss "Windows" k e y to ope n Start scree n | T ype
"Start | A ll P ro g ram s | C o d eM eter C o n tro l C en ter"
Blue double Several CmContainer are connected and activated until disconnected.
27
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Ele me nt D e scription
On Windows ope rating syste ms th is log file is store d to the dire ctory %\Programm Files%
\CodeMeter\Logs .
P rocesses M enu
Ele me nt D e scription
Eject all C m D o n g les
E je cts all conn e cte d CmDongles in on e go. Alte rnative ly, pre ss the k e y combination <CTRL>+ALT+Q .
D efrag m en t Licen se M em o ries D efragme nts the lice ns e me mory o f the s e le cte d CmContainer. Alte rnative ly, pre ss the k e y combination
<STRG>+ALT+D .
U p d ate Tim e C ertificates Update s the time ce rtificate s in the s e le cte d CmContainer. All time stamps are refre s he d.
View M enu
Ele me nt D e scription
H id e Win d o w Minimize s and h id e s the CodeMeter Control Center window back into the in fo are a o f the Windows task
bar. Alte rnative ly, pre ss the k e y combination <CTRL+M> .
R efresh
Refre s he s the display o f all conn e cte d CmContainer . Alte rnative ly, pre ss the k e y <F5> .
Zo o m in
Enlarg e s the display in the Events tab are a. Alte rnative ly, pre ss the k e y combination <CTRL>++ .
Zo o m o u t
Scale s down the display in the Events tab are a. Alte rnative ly, pre ss the k e y combination <CTRL>+ -.
C o p y Even t C o n ten t
Copie s the e ve nt actions in the Events tab are a to the clipboard. Alte rnative ly, pre ss the k e y
combination <CTRL>+C .
C lear Even t C o n ten t
D e le te s the e ve nt actions in the Events tab are a. Alte rnative ly, pre ss the k e y combination <ALT>+C .
Ele me nt D e scription
Sh o w all availab le Licen se En tries
S h ows all CmContainer lice ns e e ntrie s in the Events tab are a. Alte rnative ly, pre ss the k e y combination
<ALT>+E .
Borrow visib le T oggle s b e tw ee n a visible and not visible Borrowing tab are a.
By d efault, starting with CodeMeter Ve rsion 6.00a th is tab are a is not visible .
Help M enu
Ele me nt D e scription
H elp Ope ns the CodeMeter onlin e he lp. H e re you acce ss the he lp file s on CodeMeter License Server and
CodeMeter Control Center .
Ele me nt D e scription
N am e Ch ang e s and displays the name o f the s e le cte d CmContainer . In the subs eq ue nt dialog you can e dit the
name .
The update may tak e a couple o f minute s. You must not re move the CmDongle b efore th is
proce ss is finis he d. Othe rwis e , irre parable damag e o f the CodeMeter SmartCard Ch ip may occur.
29
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Ele me nt D e scription
C ap acity In forms on the capacity o f the CodeMeter SmartCard Ch ip o f a s e le cte d CmDongle . The capacity is
displaye d in pe rce nt format, and by numb e r o f absolute byte s.
Ple as e note th at th is value te lls noth ings about the me mory allocation o f an e ve ntual flas h
me mory o f a CmDongle .
Statu s The status group in forms on the activation status o f the s e le cte d CmDongle .
Color Status
The conn e cte d CmContainer is disable d. N o lice ns e d application can us e lice ns e in formation
in the CmContainer.
Th is is may b e the cas e , if a CmActLicense lice ns e is 'brok e n'.
The n the "Rep air license" button is available to e ve ntually re pair the lice ns e . If th is is not
succe ss ful, the following e rror me ssag e displays. In th is cas e , only a re activation is he lpful.
Ple as e contact your so ftware ve ndor.
For in formation on e ve ntual re asons for a 'brok e n' lice ns e als a look at the log on the
Events
32 tab may b e he lpf ul.
The CmDongle is e nable d as long as it is conn e cte d. If the CmDongle is re move d from the PC,
automatically the lice ns e d acce ss by applications is d e activate d.
The CmContainer is fully e nable d. In the cas e o f a CmDongle , the lice ns e d acce ss o f
applications is still fe ature d e ve n if the CmDongle is re move d.
Wibu-Syste ms re comme nds the activation status "En ab led u n til p lu g g ed o u t".
Th is e nsure s th at e ve n w he n a CmDongle is lost, unauth orize d acce ss to the lice ns e s and
pe rsonal data in the CmDongle is not possible .
Changing Activation Status
30
M anual
Cod eM eter Control Center
Ele me nt D e scription
A Maste r Password you h ave re ce ive d w he n you re giste re d at the w e bsite my.cod e me te r.com.
In ord e r to re giste r, us e the "H elp | R eg ister C m D o n g le" me nu ite m.
31
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Ele me nt D e scription
A re gistration b e ars s e ve ral advantag e s and s e rve s to provid e s e curity w he n using CodeMeter.
Only w he n you are re giste re d loosing the own password can b e re me die d by req ue sting a
Maste r Password.
1.6.4 Events Tab
This tab displays information at start and at runtim e of CodeMeter License Serv er and comprises the following items:
· number of connected Cm Container
· number of Cm Container entri es
· number of found licens e contain er at the Firm Item l evel
· access es to CodeMeter License Serv er
You configure the display of the event list using the " 28 " m enu item.
View | . . .
You log the content for the event view using the "F 27 " m enu item.
ile | Logfile
By default, starting with CodeMeter Ve rsion 6.10 this tab displays only, if borrowing clie nts e ntrie s e xist
programme d with the 'old' borrowing using pre pare d Cm Container.
This tab informs on borrowable licenses as a feature of CodeMeter license borrowing. Then licenses can also be used when the
access to license information does not require to be connected to the license server.
You can toggle the view of this tab using the " " m enu item.
View | Borrow visib le
On the right, you see all licenses available for the 'License Borrowing' feature. The licenses are ordered by existing license server, Firm
Items, and Product Items. The displayed licenses either are borrowable or inactive.
You can borrow only active licenses. You recognize active licenses by the colored symbol and the activated "Borrow " button.
32
M anual
Cod eM eter Control Center
On the left, all licenses borrowed for the local use on a PC from a license server are displayed.
These licenses are deactivated according to the defined borrowing period. However, you also have the option to return borrowed
licenses before the borrowing period expires.
1. Click on the "Return" button to return borrowed licens es, and make them availabl e again for the licens e s erver.
For refreshing the display of the tab press the key <F5> or the "Refresh" button.
This area displays information on the CodeMeter License Serv er status, i.e. if this service is started or not. If you want to change the
status, use the "Process | Stop CodeMeter Service" or "Process | Start CodeMeter Service" menu items.
WebAdmin
Click this button to open CodeMeter WebAdm in. Alternatively, you can use the "File | WebAdmin" menu item.
use the command line program cm u - CodeMeter Univ ersal Support T ool.
Using various dialogs you manually create license requests, import license updates, and, optionally, create receipts for these
operations the end-user then sends to the software vendor. Using license files also allows the activation of licenses on a PC which
has no direct Internet access. The figure below illustrates this process.
Please note that importing license updates files (*.WibuCmRaU) is currently not supported for a Cm Container in operation.
Before a license update, please save your work and close all other running CodeMeter© protected applications which access
licenses on the target Cm Container.
33
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Ple as e note that importing lice ns e update s file s (*.WibuCmRaU) is curre ntly not supporte d for a CmContainer in
ope ration.
Before a lice ns e update , ple as e save your work and clos e all othe r running CodeMeter © prote cte d applications
which acce ss lice ns e s on the targe t CmContainer .
1. Open CodeMeter Control Center. If several Cm Container are connected to the computer, select the desired Cm Container.
2. Click on the "U p date License" button.
34
M anual
Im p orting and U p d ating Licenses
35
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
36
M anual
Im p orting and U p d ating Licenses
Ple as e note that importing lice ns e update s file s (*.WibuCmRaU) is curre ntly not supporte d for a CmContainer in
ope ration.
Before a lice ns e update , ple as e save your work and clos e all othe r running CodeMeter© prote cte d applications
which acce ss lice ns e s on the targe t CmContainer .
In order to import a license update, in the start dialog select the respective option, then click the "Next" button.
37
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
38
M anual
Im p orting and U p d ating Licenses
39
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
40
M anual
Cod eM eter Web Ad m in
Communication between CodeMeter WebAdm in and connected Cm Container is browser-based and uses network components.
Thus the installation of the network protocol TCP/IP is required, and access must be granted to the localhost.
Firewall Setting s
Please also note that the settings of your firewall do not block communication.
CodeMeter License Serv er uses a specific IP port (defaulted on 22350) to communicate with your PC and the network. This
network port is registered at IANA (Internet Assigned Numbers Authority) and uniquely assigned for CodeMeter
communication.
Make sure that your firewall is not blocking this port. Enable the used IP port 22350 and make sure it is accessible by
CodeMeter, i.e. s h are the communication for th is IP port.
If the CodeMeter WebAdm in communication is required not only locally but also in server operation, you must also release
port 22352 (in the case of HTTPS, port 22353), since port 22350 is automatically forwarded.
Com m unication M od e
By editing registry or server entries you are also able to define which communication mode CodeMeter License Serv er uses.
The following table shows you where for which operating system you find the profiling to set the communication mode.
Ope rating syste m Re gistry / S e rve r Entry
Windows HKLM/SOFTWARE/WIBU-SYSTEMS/CodeMeter/Server/CurrentVersion
macOS /Library/Preferences/com.wibu.CodeMeter.Server.ini
Linux /etc/wibu/CodeMeter/Server.ini
41
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
The param eter Ap iCommunicationM ode . is available for setting the mode. The following properties are available:
CodeMeter -Ve rsion Prope rtie s
smalle r th an 4.40 '1 ' T CP/IP (D efault)
'2 ' S h are d Me mory
starting with 4.40 '1 ' Platform-spe cific (D efault)
Platform-spe cific d efaults:
· Windows: IPv6, IPv4; S h ar e d Me mory
· Linux/macOS:IPv6, IPv4
· WinCE: IPv4, S h ar e d Me mory
'2 ' S h are d Me mory
'4' IPv4
'8 ' IPv6
Single modi may b e combin e d.
Wibu-Systems recomm ends to use the relevant default settings, if no justified reasons suggest otherwise.
On all pages you are able to select from a list of available server.
Right to the display "Current Server" follows the name o f the actual PC on which the s e rvice CodeMeter License Server is
starte d. A s e arch reque st using the port 22352 is s e nt to the ne twork. For changing the s e rve r, ple as e procee d as
follows:
1. Click the icon.
A dialog displaying a list of all available server displays.
42
M anual
Cod eM eter Web Ad m in
In formation icon ch anging its color from orang e to re d in forms on important in formation to re ad and re spond,
e .g. re starting o f CodeMeter License Server.
Icon displaying lice ns e trans fe r options.
Hove r ove r control ch ang e s color to orang e and displays in formation. A click advance s to the Product Item d e tail
pag e .
Icon displaying lice ns e trans fe r h istory.
Hove r ove r control ch ang e s color to orang e and displays in formation. A click advance s to the Product Item d e tail
pag e .
Action e le me nt D e scription
Ope ns a dialog to s e le ct available s e rve r.
Updating the Certified Time o f the CmContainers using a CodeMeter T ime Server.
D e le te s a list e ntry.
43
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Action e le me nt D e scription
Move s up a list e ntry a le ve l h ig he r.
1.8.4 Dashboard
The dashboard displays basic server information on the CodeMeter runtim e.
Ele me nt D e scription
C u rren t Server N ame o f the mach in e on w h ich the s e rvice CodeMeter License Server h as b ee n starte d.
IP A d d ress S h ows in formation on the n e twork addre ss in us e .
O p eratin g S h ows in formation on the ope rating syste m in us e .
System
C ertificate Optionally s h ows d e tails on ce rtificate s e xpiration time s, if H TT PS h as b ee n s e le cte d as protocol and s e lf-sign e d ce rtificate s
exp iratio n
tim e
are us e d as d efin e d on the We bAdmin con figuration pag e 64 .
1.8.5 Container
Using the Container navigation item finds information on connected Cm Container. This covers:
· licens es 45 including detail ed information on Firm Items 46 and Product Items 46 .
· CmContainer Info 49
· User data 50 including detail ed information on Product Items 51
· Backup and Restore 51
If you open a selected Cm Container using CodeMeter Control Center, only this single Cm Container displays. At the sam e
tim e, the tab Licenses opens. This also is the case, if you select a single Container from the list of All Containers.
44
M anual
Cod eM eter Web Ad m in
1.8.5.1 Licenses
The expanding area "Licenses" displays all licenses the selected Cm Container holds.
· If a license is expired or an Unit Counter has reached a value of 0, the license entry is in red writing.
In the figure above, this is, for example, the product "Spreadsheet Application" with the Product Code of 13 or the product "Chart
Application" with a Product Code of 14. In addition, you obtain further information 40 on existing Unit Counter, Valid Until (Usage
P eriod, Expiration Tim e, Activation Tim e), License Quantity and Feature M ap .
Click on the highlighted Firm Code 46
entry for the display of more detailed information on the license conditions of products by a
specific vendor.
Click on the highlighted Product Code 46
,entry for the display of more detailed information on the license conditions of products by a
specific vendor.
45
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Ele me nt D e scription
C m C o n tain er N ame o f the CmContainer including mask and s e rial numb e r.
F irm A ccess
Displays the Firm Access Counter re ading. The Firm Access Counter (FAC) locate s at the Firm Item le ve l o f a CmContainer.
Th is counte r allows to control w he the r a Firm Item can b e us e d for e ncryption purpos e s.
C o u n ter
By d efault, the FAC is d e activate d and h as a value o f 65535 (0xFFFF) . It can b e programme d by the so ftware
ve ndor to any othe r value .
F irm U p d ate
Displays the Firm Update Counter (FUC) re ading. Th is counte r is automatically incre me nte d on programming.
C o u n ter
F irm P recise
Displays the time o f the Firm Item -programming.
Tim e
The license properties as displayed in the figure above are not always set. The display of your license may differ.
If license properties (Product Item Options) display in red, these properties are invalid.
46
M anual
Cod eM eter Web Ad m in
Ele me nt D e scription
P ro d u ct Item O p tio n s
In the first column you s ee the Product Item Options and the display in the cas e o f data fie lds the ind e x fie ld
via the # ch aracte r. The s e are lice ns e prope rtie s s e t by the lice nsor. For illustrative re ason the figure lists
all options. Whe n liste d in othe r cas e s, not all o f the s e options 40 are always displaye d.
In the figure above you s ee th at the lice ns e h as b ee n borrow e d for the local us e .
Size (B ytes) The column the numb e r o f byte s a liste d lice ns e prope rty allocate s.
D ep en d en cies The column in forms w he the r a lice nsor h as s e t d e pe nd e ncie s for the programming s eq ue nce o f the
CmContainer .
Valu es The final column displays the store d value o f the single lice ns e prope rty.
Disp lay of Universal Data (UvD)
The detailled information of the Product Item Option Universal Data (UvD) informs on the UvD data types and respective access
permissions for different access modes.
47
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Figure 36: CodeMeter WebAdmin – Product Ite m D e tails -Universal Data (UvD )
Ele me nt D e scription
P ro d u ct Item O p tio n s The column in forms about the Product Ite m Option and displays the ind e x fie ld via the ch aracte r.
#
Size (B ytes) The column the numb e r o f byte s a liste d lice ns e prope rty allocate s.
D ep en d en cies The column in forms w he the r a lice nsor h as s e t d e pe nd e ncie s for the programming s eq ue nce o f the
CmContainer .
Valu es
The column in forms about the us e d UvD data type (Ke y, Data and Password).
P erm issio n s The column in forms for e ach type o f acce ss ( ,read , ) about the acce ss pe rmissions with the
write u se
value s ,
d en ied or with
u n restricted q
p asswo rd re . The fie ld
u ired s h ow w h ich -ind e x fie ld
in d ex(es) #
contains req uire d passwords (a single password or additionally with maste r password).
48
M anual
Cod eM eter Web Ad m in
The drive size is only displaye d in the cas e o f CmDongles with Flas h me mory.
Statu s S h ows the curre nt activation status o f the s e le cte d CmContainer. The following status s e ttings are
displaye d:
· D isab led :
The conn e cte d CmContainer is d e activate d and not usable by any application.
· En ab led u n til U n p lu g g ed :
The CmDongle is activate d as long as it is conn e cte d and supplie d by e le ctrical e n e rgy. Afte r re move d
from the PC the CmDongle is automatically d e activate d.
· En ab led :
The CmContainer is fully activate d. If a CmDongles is re move d, the lice ns e acce ss is still possible a fte r
plug out.
· Em p ty:
lice ns e s and pe rsonal data in the CmDongle is lost, unauth orize d acce ss to the lice ns e s and
pe rsonal data is not possible .
System Tim e (P C ) S h ows the System Time (local time on the PC) w he n the s e rvice CodeMeter License Server h as starte d.
System Tim e (C m C o n tain er) S h ows the save d System Time (inte rnal time ) o f the CmContainer.
49
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Ele me nt D e scription
The s e two syste m time s may diffe r due to the pe nding synch ronization proce ss.
C ertified Tim e (C m C o n tain er)
S h ows the Certified Time save d in the CmContainer. In ord e r to update the Certified Time o f your
CmContainer using a CodeMeter T ime S e rve r, click the button. Th is action is con firme d by a dialog.
50
M anual
Cod eM eter Web Ad m in
Note, that the backup and restore m echanism only comprise the user data in the Cm D ongle but no license information of
other licensors. Backup and restore exclusively relates to the license container with the Firm Code "0".
In order to restore licenses which do not locate in the personal area (Firm Item levels unequal to Firm Code "0" ), please contact
Wibu Support.
51
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Are a D e scription
Backup 1. Click the "Backup now " button to apply an instant backup o f your pe rsonal CmDongle data (us e r
data). In addition, the time o f the Last Backup is displaye d.
2. Con firm the following dialog to cre ate the backup file .
Restore 1. Click the "Browse" button to s e le ct the backup copy w h ich is to b e re store d. The location o f the
backup file displays.
2. Click the "Restore" button to start the re storing proce ss.
3. Con firm the following dialog and click the "OK" button.
If you import a backup into the CmDongle , all ch ang e s a fte r the backup was cre ate d are lost.
4. Ente r the Password o f the CmDongle in w h ich the backup file is to b e importe d.
52
M anual
Cod eM eter Web Ad m in
You are also able to import the save d data into anothe r CmDongle . Ple as e note , h ow e ve r,
th at the s e cond CmDongle must h ave the same password !
number of licenses..
availab le
In addition, an expandable area structures the licenses according to access modes (U ser Limit (Borrowed), N o U ser Limit, Exclusive,
Shared ) and s h ows availab le licens es.
You us e th is s e tting, for e xample , w he n you want to provid e the e nd-us e r with the option o f starting the
application s e ve ral time s. On a te rminal s e rve r e ach s e ssion allocate s a lice ns e . In virtual mach in e s e ach
mach in e allocate s a lice ns e .
StationS h are avoids unn e ce ssary duplication o f lice ns e allocation by e nsuring th at lice ns e acce ss e s -
locally or ove r a n e twork - and the d efin e d allocation s eq ue nce do not ove rlap.
53
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Ele me nt D e scription
For e xample , if a lice ns e acce ss (h andle ) mad e via n e twork (LAN ) with StationS h are will b e d e te cte d, the n
no n e w lice ns e will b e assign e d locally d e spite the d efin e d allocation s eq ue nce (first locally, the n via
n e twork, i.e . LOCAL_ LAN tag).
In addition, if a lice ns e is alre ady acce ss e d locally, no n e w lice ns e acce ss (h andle ) will b e mad e via the
n e twork, if the local acce ss could also b e mad e via StationS h are .
Exclusive H e re a prote cte d application can b e starte d only once on a PC.
N o Us e r Limit H e re any numb e r o f instance s o f the prote cte d application can b e starte d locally or in a n e twork, and no
additional lice ns e s are allocate d. Allocate d lice ns e s in th is mod e can b e re -us e d.
1.8.6.1 License Monitoring Details
The "License Monitoring Details" page displays detailed information on the license allocation.
You cannot deallocate and reallocate borrowed licenses before they have been returned.
For example, this is necessary when all licenses are allocated but an additional instance of the application needs to be started.
54
M anual
Cod eM eter Web Ad m in
After deleting of an access the license is deallocated and available again. The client of the application receives a respective
error m essage.
1.8.6.2 Sessions
The "License Monitoring | Sessions" page displays all existing licenses ordered by users actually logged on ( Clients ).
For Windows operating systems you find the profiling entries stored in the registry, for other operating systems entries are set
in the file server.ini. The following table shows you the respective locations.
Ope rating syste m Re gistry / S e rve r.ini Entry
Windows HKLM/SOFTWARE/WIBU-SYSTEMS/CodeMeter/Server/CurrentVersion
macOS /Library/Preferences/com.wibu.CodeMeter.Server.ini
Linux /etc/wibu/CodeMeter/Server.ini
There exist two relevant profiling entries for License T racking.
Entry Prope rty
Value
LogLicenseTracking [DWord] [0;1]
55
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Please note that you must stop the CodeMeter License Serv er service, make the change, and then restart the
CodeMeter License Serv er s ervice b efore the ch ang e can take effect.
On the basis of selectable Firm Codes, log files and licenses, accesses are displayed graphically and in detail. The created report may
serve to use information on license requests and denials for saving license costs and create forecasts or prognoses.
Using a separate navigation the number and origin of allocated, rejected or released licenses can be tracked according to specified
view modes (month, day, hour). Clicking on the displayed bars shows more details on the use of licenses.
For using license tracking, please proceed as follows:
1. Select the desired Firm Code using the field "Select Firm Code ".
56
M anual
Cod eM eter Web Ad m in
8. Move over a bar again and left click to open the separate Details area.
Detailed information and separate tables for single bars list details on Active Users , Rejected Requests and All Events .
57
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
d e scrib e s th at a us e r req ue ste d a lice ns e but did not g e t on e b e caus e no more lice ns e s could b e
allocate d.
It will not s h ow lice ns e req ue sts o f lice ns e s th at do not e xist on th is s e rve r.
58
M anual
Cod eM eter Web Ad m in
Ele me nt D e scription
A ccess
1.8.8 Configuration
Using the Config uration navigation item allows you to configure the following settings:
· Basic 60
· Server 69
· Advanced 79
59
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
also ch ang e the ord e r by using the u p and d o wn buttons. You save t he ch ang e s you mad e by
You s e t back the s e ttings o f the s e rve r s e arch list using the "Restore Defaults" button.
Alte rnative ly, you are also able to s e t the S e rve r S e arch List using the con figuration file s
CodeMeter.ini or Server.ini . The table b e low s h ows you w he re to find the re spe ctive file s.
Ope rating Syste m Con figuration File
Windows %Program Files%\CodeMeter\Runtime\bin\CodeMeter.ini
macOS \Library\Preferences\com.wibu.CodeMeter.Server.ini
Linux \etc\wibu\CodeMeter/Server.ini
In the s e parate s e ction [ServerSearchList] d efin e the s e rve r as the e xampe b e low s h ows:
[ServerSearchList]
[ServerSearchList\Server1]
Address=184.45.89.5
[ServerSearchList\Server2]
Address=185.55.78.6
Whe n you d efin e n e twork s e ttings, in some cas e s, th is req uire s the re start o f the CodeMeter s e rvice .
How e ve r, you do not h ave to eje ct or d e activate the CmContainer. Afte r you spe cifie d the s e ttings you
are able to stop and the n re start the CodeMeter s e rvice in CodeMeter Control Center 28 . For non-
Windows ope rating syste ms s ee he re 25 .
In ord e r to che ck for a succe ss ful conn e ction, on the "Home" pag e click the "Host Name" button and look
for the succe ss ful appe nding o f the PC as s e rve r. The che ck works also by ope ning CodeMeter Control
Center on t he clie nts and t he s e rve r and looking f or t he communication status in t he r e spe ctive
If a conn e ction is still not e stablis he d spe cify on the clie nt PCs the s e rve r IP addre ss.
60
M anual
Cod eM eter Web Ad m in
By spe cifying the PC name s or IP addre ss e s you d efin e th at the clie nt req ue sts e xactly addre ss the
d efin e d CodeMeter n e twork s e rve r. Th is incre as e s the pe rformance on the n e twork.
If the CodeMeter n e twork s e rve r is locate d in anothe r subn e t, you s h ould always spe cify the IP
addre ss in the s e rve r s e arch list in ord e r to pre clud e UDP broadcast proble ms.
By d efault, CodeMeter License Server binds to the first n e twork adapte r found.
U sing in a wide area network (WAN ):
Spe cify the IP addre ss(e s) for clie nt req ue sts to the d efin e d CodeMeter License Server in the WAN .
Whe n spe cifying the IP addre ss(e s) ple as e note th at you are req uire d to prefix a "https:\
\ "n ee d e d for the s e cure d communication with a re ve rs e proxy in the WAN .
ad d au to m atic server search Th is e ntry allows to automatically s e arch lice ns e s on s e rve rs, first locally and the n in the n e twork
(subn e t). A so-calle d broadcast is pe rforme d.
If CodeMeter WebAdmin finds the e ntry 255.255.255.255, it is displaye d as "Automatic server
search (255.255.255.255)" on t he list.
1.8.8.2 Proxy
On the "Configuration | Basic | Proxy" page you define settings when using a proxy server. You require a proxy server, for example,
coupled with:
· Firmware update
· update of the certified time using a Wibu-Systems tim e server
· access via CmWAN on a remote CodeMeter s erver.
By default, the system p roxy setting s apply.
Please note, that under Linux, the environm ent variable http_proxy is considered as system proxy. https_proxy is not yet
supported.
61
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Please note, that under Linux, the environm ent variable http_proxy is considered as system proxy. https_proxy is not yet
supported.
c) M anual p roxy config uration
62
M anual
Cod eM eter Web Ad m in
1.8.8.3 WebAmin
On the "Configuration | WebAdm in" page you defining settings to manage the access (local and remote), select the desired
protocol (HTTP or HTTPS), and specify the eventually required authentication credentials for accessing CodeMeter WebAdm in.
The pictograms and inform on Read and Write access. On mouse over tool tips display additional access mode details.
A click on a pictogram opens - if required - the login on a separate page.
Depending on the configured access modes a dropdown m enu provides the following entries:
· Allow write access
A change of this during operation requires a restart of the Cm WebAdm in service. Please note that you also have to set the
firewall accordingly.
Please proceed as follows to restart the Cm WebAdm in service on Windows:
1. Enter "Services" in the Windows search field.
2. Find CmWebAdmin in open Services window.
3. Click right mouse button and select Restart.
On macOS first stop the service and than start it using the following commandlines:
sudo launchctl stop com.wibu.CodeMeter.WebAdmin
sudo launchctl start com.wibu.CodeMeter.WebAdmin
On Linux for a restart of the service use the following commandline:
sudo service codemeter-webadmin restart
P rotocol Selection
This group allows you selecting the protocol used for accesses. Optionally, you can select between HTTP and HTTPS.
63
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Ele me nt D e scription
H TTP (sets au th en ticatio n to If you us e H TT P (d efault), you do not req uire any authe ntication. The re late d "Req uire d Authe ntication"
n o n e)
radio button is automatically s e t to 'N on e '.
If you us e H TT PS, you can additionally d e cid e w he the r using an automatically cre ate d s e lf-sign e d
ce rtificate or a custom ce rtificate you obtain e d from a s e parate ce rtification auth ority (CA) provid e r.
H TTP S (with au to m atically created
self-sig n ed certificate)
Automatically s e lf-sign e d ce rtificate file s, i.e . the Ce rtificate Ch ain/File and the Ke y File will b e cre ate d, if
not alre ady e xisting, at the displays location,
H TTP S with cu sto m certificate
H e re you e nte r path and file name s o f the ce rtificate file s you obtain e d from your ce rtification auth ority
(CA) provid e r.
Ple as e note th at the CmWebAdmin S e rvice now only runs und e r the "Local S e rvice " account and
not und e r the "Syste m" account.
Th is me ans th at it is no long e r allow e d to acce ss file s/fold e rs b e longing to a us e r account, e .g.
file s o f the curre ntly logg e d in us e r (e ve ryth ing b e low C:\Users\<username>). The refore ,
ple as e store the ce rtificate s dire ctly und e r drive C:\ or anothe r partition, e .g. D:\ .
After selecting the HTTPS protocol and opening CodeMeter WebAdm in the first tim e, the web browser issue warnings for not secure
connections.
If you use automatically generated, self-signed certificate files, you must nevertheless allow the access despite unsafe access
information, and eventually define exceptions. The unsafe information refer only to the fact that certificates are self-signed
and not issued by a certification authority (CA).
If you have received certificate files from a certification authority (CA) provider, please follow the respective import
instructions.
If self-signed certificates expire and becom e invalid, a separate entry on the Dashboard 44 page will inform you displaying
details on the certificate expiration tim e.
Please proceed for Firefox, Chrom e, Internet Explorer, Microsoft Edge and Safari as follows.
Firefox
After selecting the HTTPS protocol and opening CodeMeter WebAdm in the first tim e, the following page displays.
64
M anual
Cod eM eter Web Ad m in
Chrom e
After selecting the HTTPS protocol and opening CodeMeter WebAdm in the first tim e, the following page displays.
65
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Internet Explorer
After selecting the HTTPS protocol and opening CodeMeter WebAdm in the first tim e, the following page displays.
Microsoft Edge
After selecting the HTTPS protocol and opening CodeMeter WebAdm in the first tim e, the following page displays.
66
M anual
Cod eM eter Web Ad m in
Safari
After selecting the HTTPS protocol and opening CodeMeter WebAdm in the first tim e, the following page displays.
Re q uired Authentication
This group allows you specifying the required authentication credentials for accessing CodeMeter WebAdm in with Write and/or
Read privileges.
Ele me nt D e scription
N o n e (N o rem o te write N o authe ntication is req uire d but also no re mote write acce ss to CodeMeter WebAdmin is possible .
access p o ssib le)
Write A ccess (re q u ires Activate th is option to allow authe nticate d write acce ss to CodeMeter WebAdmin .
H TTP S)
Ple as e comple te the n e ce ssary data in the fie lds Password and Verify Password for Write Acce ss, and click the
button "Apply".
The n write acce ss will req uire a login on a s e parate login pag e .
Ple as e click the button "Login for write permission ".
R ead an d Write A ccess In ord e r to organize re ad and write acce ss e ve n more fin e -grain e d, you are able to us e diffe re nt cre d e ntials
(re q u ires H TTP S) for diffe re nt groups allow e d for authe nticate d re mote re ad and/or write acce ss to CodeMeter WebAdmin.
67
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Ele me nt D e scription
Ple as e comple te the n e ce ssary data in the fie lds Password and Verify Password for Re ad and Write Acce ss.
The n re ad acce ss will req uire a login on a s e parate login pag e .
Write acce ss will additionally req uire a login on a s e parate login pag e .
Ple as e click the button "Login for write permission ".
Click the "Ap p ly" button to save all the changes you have made. By a previous click on the "Restore Defaults" button you save
the default settings.
1.8.8.4 Backup
On the "Configuration | Basic | Backup" page you define settings for the location and intervals of Cm D ongle data backups.
Ele me nt D e scription
B acku p P ath Spe cify in the B acku p P ath fie ld the location w he re the backup file o f the CmDongle is to b e save d.
The d efault location for backup file s d e pe nds on the ope rating syste m in us e .
B acku p In terval Spe cify in the B acku p fie ld the re curring time pe riod for automatic backups.
In terval
By d efault, automatically a data backup is e xe cute d e ve ry 24 h ours. How e ve r, you are also able to
cre ate a backup for the CmDongle at any time .
C ertified Tim e Activate th is option w he n a C ertified Tim e update h as to tak e place b efore a backup is e xe cute d.
Click the "Ap p ly" button to save the changes you have made.
By a previous click on the "Restore Defaults" button you save the default settings.
68
M anual
Cod eM eter Web Ad m in
Figure 51: CodeMeter WebAdmin – "Con figuration | S e rve r | S e rve r Acce ss"
For activating the Network Server option, ple as e procee d as follows:
1. Click the "Enab le" radio button to us e the PC as CodeMeter ne twork s e rve r.
Then this PC provides its CodeMeter licens es on the network using the s ervice CodeMeter License Serv er.
2. Spe cify a Network P ort. By default, the port 22350 is us e d for the CodeMeter communication.
This network port is registered at IANA (Internet Assigned Numb ers Authority) and uniquely assigned for the
CodeMeter communication.
You are able to customize this port value . Howe ve r, mak e sure that all CodeMeter License Serv er us e this port
whe n a CodeMeter prote cte d application is to b e us e d on the ne twork.
3. Click the "Ap p ly" button to save the changes or "Restore D efaults" re storing the default s e ttings.
Ple as e note , that a WAN conne ction has to b e provide d by the So ftware Ve ndor.
2. Spe cify a CmWAN P ort . By default, the port 22351 is us e d for the CodeMeter communication via WAN.
You are able to customize this value . In this cas e , mak e sure that:
· all CodeMeter License Serv ers us e this port, if CodeMeter prote cte d applications acce ss lice ns e s via WAN.
· the configure d re ve rs e proxy has the same port s e tting.
Please note, that under Linux, the environm ent variable http_proxy is considered as system proxy. https_proxy
is not yet supported.
3. Click the "Ap p ly" button to save the changes or "Restore D efaults" re storing the default s e ttings.
Please note that changes made to the port settings require a restart 25 of CodeMeter License Serv er.
Please note, that you previously must have configured CodeMeter License Serv er (CodeMeter.exe) as a network or a
CmWAN server ("Server Access 69 ").
At the sam e tim e, also the license access permissions for localhost are managed.
On access configuration you can select among a basic and an advanced mode.
The basic 70 mode allows adding client computer and IP addresses for accessing CodeMeter License Serv er.
The advanced 71 mode allows, for example, specifying global and specific access rules for accessing licenses and reserving license
access for single staff m ember or complete Active Directory groups.
Please select the desired License Access P ermissions mode.
69
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Please note that for the operating systems macOS and Linux the use of the advanced 71 mode for license access
permissions is possible in principle, but that the configuration of group rules is not supported.
B asic M od e
Ele me nt D e scription
C lien ts S h ows a list o f all clie nt PCs w h ich h ave the privile g e to us e CodeMeter License Server, i.e . to allocate a
lice ns e .
Whe n th is list is e mpty, e ach CodeMeter clie nt on the n e twork is able to us e CodeMeter License
Server . Th is is t he d ef ault s e tting.
2. Spe cify the PC name or the IP addre ss o f the clie nt in the dialog.
3. Click the "OK" button.
The PC is now add e d to the clie nt list.
T o re move a clie nt from the list, ple as e procee d as follows:
1. Click the "Remove" button.
The PC is now re move d from the clie nt list
En ab le F SB A ccess
If you own a CodeMeter Firm Security Box (FSB), th is option activate s the s h aring o f the FSB on the
n e twork. The n the FSB is able to b e us e d by s e ve ral us e rs, for e xample , to program CmContainer or
automatically prote ct applications.
Th is option mak e s s e ns e only for CodeMeter lice ns ee with an individual CodeMeter Firm Code.
Click the "Apply" button to save the ch ang e s you h ave mad e . By a pre vious click on the "Default" button
you save the d efault s e ttings. The n the clie nt list is e mpty, and the FSB is not available on the n e twork.
Whe n you d efin e acce ss s e ttings, in some cas e s, th is req uire s the re start o f the CodeMeter
s e rvice . How e ve r, you do not h ave to eje ct or d e activate the CmContainer. Afte r you spe cifie d the
70
M anual
Cod eM eter Web Ad m in
Ele me nt D e scription
s e ttings you are able to stop and the n re start the CodeMeter s e rvice in CodeMeter Control
Center
28 . For non-Windows ope rating syst e ms s ee he r e 25 .
Alternatively, you also have the option to create a white or blacklist for the access of clients.
Please note that on specifying subnet masks only input dividable by 8 is accepted.
This so-called profiling you conduct for different operating systems at the following locations:
Ope rating Syste m Pro file Cre ation
macOS /Library/Preferences/com.wibu.CodeMeter.Server.ini
Linux /etc/wibu/CodeMeter/Server.ini.
The generation of the profile for CodeMeter License Serv er comprises the following versions (CodeMeter.exe, CodeMeterMacX,
CodeMeterLin).
When you edit the *.ini files in the case of macOS and Linux, you must stop the service CodeMeter License Serv er before.
Otherwise, changes you have been made do not apply.
Parame te r D e scription
<in d ex>=<Su b n etz >[,
C lien t
Whitelist :
<serial >[, F C [,P C ]]]]
The s e parame te rs h old the IP addre ss e s o f clie nt PCs on the n e twork w h ich h ave the privile g e to acce ss the
local CodeMeter License Server. Whe n the IP addre ss o f a clie nt is not on th is list, the acce ss is d e nie d.
(Wh itelist)
If no w h ite list e xists, no othe r re strictions apply. The spe cification o f subn e ts is possible .
The syntax is as follows:
Client<index>=<Subnetz>[,<serial>[,FC[,PC]]]
The s e rial numb e r h as to follow the patte rn MaskByte-Serial Number (e .g. 1-1179681).
Example :
Clie nt1= 192.16 8 .0.0/24,1-123456,10,13
th is addre ss e s all compute r ranging from 192.16 8 .0.0 to192.16 8 .0.255 (Class C). Usually are also /8 (Class A)
and /16 (Class B).
The s e rial numb e r, FC, and PC are optional.
Th is w h ite list corre sponds to the clie nt list in CodeMeter WebAdmin.
B lacklist <in d ex>=<Su b n etz Blacklist:
>[, <serial >[, F C [,P C ]]]]
[SZ, o p tio n al ] The s e parame te rs h old the IP addre ss e s o f clie nt PCs on the n e twork w h ich h ave no privile g e to acce ss the
local CodeMeter License Server. Whe n an IP addre ss o f a clie nt is on th is list, the acce ss is d e nie d.
If no blacklist e xists, no othe r re strictions apply.
The syntax is as follows:
Blacklist<index>=<Subnetz>[,<serial>[,FC[,PC]]]
The s e rial numb e r h as to follow the patte rn MaskByte-Serial Number (e .g. 1-1179681).
Example :
Blacklist1= 192.16 8 .0.0/24,1-123456,10,13
th is addre ss e s all compute r ranging from 192.16 8 .0.0 to192.16 8 .0.255 (Class C). Usually are also /8 (Class A)
and /16 (Class B).
The s e rial numb e r, FC, and PC are optional.
Ad vanced M od e
The advanced access control mode allows the controlling of license access using access rules. The license access by single staff
m embers but also of complete Active Directory groups can be organized. The detection of single staff m embers (user nam e) and
groups happens automatically without any integration efforts.
71
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Figure 53:: CodeMeter WebAdmin - "Con figuration | Acce ss Control“ - Advance d Acce ss Control Mod e
The advanced access control mode allows the controlling of license access using access rules. The license access by single staff
m embers but also of complete Active Directory groups can be organized. The detection of single staff m embers (user nam e) and
groups happens automatically without any integration efforts.
The list of License Access P ermissions (access control list) can be exported or imported 103 in a *.json format using the
103
Please note that reading complete Active Directory (AD) groups depending on the complexity of their structures may take
som e tim e.
In order to create the global access rules to control license access globally for all Cm Container, please proceed as follows:
1. Select the "Glob al access rules" item in the left tree view.
2. Click the "Add new access rule" button.
A dialog for defining a new rule displays.
72
M anual
Cod eM eter Web Ad m in
3. Click the "Allow" or "D eny" radio button in the area Action to decide, whether the following license access by client is to be
allowed or denied.
A client access can be defined by one of the following param eter: H ost name , Sub net address U ser or Group nam e.
4. Specify the desired param eter in the respective field. If an active directory (AD) is integrated, the list of fields U ser and Group is
auto-completed.
Setting a profiling param eter allows to defne the update interval 22 to display this list.
5. Click the "Add" button to add the new rule.
A click on the "Cancel" button cancels the process.
The new rule displays in the right rule view.
If you defined several rules, you may change the rule sequence by using the arrow symbols . Rules are processed top-down,
which m eans that the order of the rules is decisive for the result.
Using the "Edit" or "D elete" link allows you to modify a completely delete a rule.
6. Define the default setting for all license accesses which are not covered by rules.
You have the option to set the D efault action to allow or deny license access.
Click the "Allow" or "D eny" button.
7. Click the "Ap p ly" button in the lower part to save the changes made to the global access rules. Using the "U ndo Changes"
button reverts the global access rules prior to the modification, and the "Restore D efaults" button applies the default settings.
If you apply the changes made, please restart 25 CodeMeter License Serv er.
The figure below shows an example of global access rules. It allows the global license access additionally by a guest user. All
other licenses accesses are also allowed, if no specific access rules specify otherwise.
Figure 54:: CodeMeter WebAdmin - "Con figuration | Acce ss Control“ - advance d Mod e - global acce ss rule s
In addition to defining the global access rules, you have also the option to control the license access to specific separate license
entries. Here you define specific access rules for separate defined Firm Codes, Product Codes or Containers (Serial Numbers).
Firm Code -sp ecific access rules
In order to create specific access rules to control license access to separate Firm Codes, please proceed as follows:
1. Select the "Sp ecific access rules" item in the left tree-view.
2. Click the "Add F irm Code" button.
The dialog for selecting a Firm Codes displays.
73
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
5. Click the "Allow" or "D eny" radio button in the area Action to decide whether the following license access by client is to be
allowed or denied.
A client access can be defined by one of the following param eter: H ost name , Sub net address U ser or Group nam e.
6. Specify the desired param eter in the respective field. If an active directory is integrated, the list of fields U ser and Group is auto-
completed.
7. Click the "Add" button to add the new rule.
A click on the "Cancel" button cancels the process.
The new rule displays in the right rule view.
If you defined several rules, you may change the rule sequence by using the arrow symbols . Rules are processed top-down,
which m eans that the order of the rules is decisive for the result.
Using the "Edit" or "D elete" link allows you to modify a completely delete a rule.
If you delete Firm Code-specific access rules using the "D elete rule list" button, then also all Product Code-specific access rules - if
existing - are deleted.
8. Define the default setting for all license accesses which are not covered by rules.
You have the option to set the D efault action to allow or deny license access.
Click the "Allow" or "D eny" button.
9. Optionally, you are able to clone an existing rule set for a Firm Code (FC) 1:1 to another Firm Code.
Click the button "Clone F C rule set" to open a dialog which allows to select a target Firm Code. Clicking the button "Clone" starts
the process.
74
M anual
Cod eM eter Web Ad m in
Clicking the button "D elete F C rule set" deletes all rules.
Please note that not only the Firm Code rule set is removed but ALL rules also for any subordinate Product Codes.
10. Click the "Ap p ly" button in the lower part to save the changes made to the global access rules. Using the "U ndo Changes"
button reverts the global access rules prior to the modification, and the "Restore D efault" button applies the default settings.
If you apply the changes made, please restart 25 CodeMeter License Serv er.
The figure below shows an example Firm Code-specific access rules. It allows the license access to the complete Firm Code 10
by a guest user and the complete support departm ent. All other licenses accesses are also allowed, if no specific access
rules specify otherwise.
Figure 55:: CodeMeter WebAdmin - "Con figuration | Acce ss Control“ - Advance d Mod e - Spe cific acce ss rule s - Firm Code
Creating a Product Code-specific access rules requires a previously created Firm Code-specific access rules.
1. Select the "Sp ecific access rules" item in the left tree-view.
2. Click the "Add P roduct Code" button.
The dialog for selecting a Product Code displays.
75
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
5. Click the "Allow" or "D eny" radio button in the area Action to decide whether the following license access by client is to be
allowed or denied.
A client access can be defined by one of the following param eter: Comp uter name , Sub net address U ser or Group nam e.
6. Specify the desired param eter in the respective field. If an active directory is integrated, the list of fields U ser and Group is auto-
completed.
7. Specify the number of license accesses which can be optionally reserved for a defined client in the field Reserved. The field Limit
states the allowed maximum of allocated license accesses by this client. The setting for a reserved license access always available
for the client is: Reserved: 1; Limit: 1.
Please note that in the case of further specific access rules reservations and limits are added. The value of the License
Quantity must not be exceeded.
If a rule applies but according to the limit set no licenses can be allocated by this rule, then it is assum ed that the rule
does not apply and the next rule is applied.
8. Click the "Add" button to add the new rule.
A click on the "Cancel" button cancels the process.
The new rule displays in the right rule view.
If you defined several rules, you may change the rule sequence by using the arrow symbols . Rules are processed top-down,
which m eans that the order of the rules is decisive for the result.
Using the "Edit" or "D elete" link allows you to modify a completely delete a rule.
In order to delete a complete Product Code-specific access rules use the "D elete rule list" button.
9. Define the default setting for all license accesses which are not covered by rules.
You have the option to set the D efault action to allow or deny license access.
Click the "Allow" or "D eny" button.
10. Optionally, you are able to clone an existing rule set for a Product Code (PC) 1:1 to another Product Code.
Click the button "Clone P C rule set" to open a dialog which allows to select a target Product Code. Clicking the button "Clone"
starts the process.
76
M anual
Cod eM eter Web Ad m in
Clicking the button "D elete P C rule set" deletes the com p lete rule set for this Product Code.
11. Click the "Ap p ly" button in the lower part to save the changes made to the global access rules. Using the "U ndo Changes"
button reverts the global access rules prior to the modification, and the "Restore D efaults" button applies the default settings.
If you apply the changes made, please restart 25 CodeMeter License Serv er.
The figure below shows an example of a specific access rules with exclusive access rights (Reserved: 1; Limit: 1) to the Product
Code 201000 of Firm Code 10 for a guest user, the complete support departm ent and a Supervisor. 2 license accesses of a
total of 5 license accesses (license quantity) remains available and the default license access is defined as allowed.
Figure 56:: CodeMeter WebAdmin - "Con figuration | Acce ss Control“ - Advance d Mod e - Spe cific acce ss rule s - Product Code
77
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
6. Click the "Allow" or "D eny" radio button in the area Action to decide whether the following license access by client is to be
allowed or denied.
A client access can be defined by one of the following param eter: H ost name , Sub net address U ser or Group nam e.
7. Specify the desired param eter in the respective field. If an active directory is integrated, the list of fields U ser and Group is auto-
completed.
8. Click the "Add" button to add the new rule.
A click on the "Cancel" button cancels the process.
The new rule displays in the right rule view.
If you defined several rules, you may change the rule sequence by using the arrow symbols . Rules are processed top-down,
which m eans that the order of the rules is decisive for the result.
Using the "Edit" or "D elete" link allows you to modify a completely delete a rule.
9. Define the default setting for all license accesses which are not covered by rules.
You have the option to set the D efault action to allow or deny license access.
Click the "Allow" or "D eny" button.
10. Optionally, you are able to clone an existing rule set for a Container 1:1 to another Container.
Click the button "Clone Container rule set" to open a dialog which allows to select a target Container. Clicking the button "Clone"
starts the process.
Clicking the button "D elete Container rule set" deletes all rules.
Please note that not only the Container rule set is removed but ALL rules also for any subordinate Firm Code rule sets and
remove the current Container form the configuration.
11. Click the "Ap p ly" button in the lower part to save the changes made to the global access rules. Using the "U ndo Changes"
button reverts the global access rules prior to the modification, and the "Restore D efault" button applies the default settings.
If you apply the changes made, please restart 25 CodeMeter License Serv er.
78
M anual
Cod eM eter Web Ad m in
The figure below shows an example Container-specific access rules. It allows the license access to the Container for the
complete Firm Code 10 by a guest user and the complete support departm ent. All other licenses accesses are also allowed, if
no specific access rules specify otherwise.
Figure 57:: CodeMeter WebAdmin - "Con figuration | Acce ss Control“ - Advance d Mod e - Spe cific acce ss rule s - Container
These settings display only, if activated at "Configuration | Advanced Configuration | Extra" in the group Additional
WebAdm in Configuration 83 .
Please note, that Prepared License Borrowing supports only Firm Codes smaller than 6.000.000.
Figure 5 8 : CodeMeter WebAdmin – "Con figuration | S e rve r | Pre pare d Lice ns e Borrowing"
For the individual setting of License Borrowing param ete, please proceed as follows:
1. Activate the option "Overwrite Entry Settings" in order to allow modifying license options of the borrowed license.
2. Enter in the field "M aximum Borrow D uration" the maximum borrowing period in minutes, the license is to be borrowable.
3. Enter in the field "M aximum Borrow Quantity" the maximum number of borrowed license to be borrowable.
4. Select in field "Server I dentification" how the server is identified: either by Server Nam e or IP address.
5. Click the "Ap p ly" button to save the changes or "Restore D efaults" re storing the default s e ttings .
1.8.8.8 CodeMeter Time Server
On the "Configuration | Advanced | CodeMeter Tim e Server" page you define settings for the CodeMeter T im e Serv er.
Please note that only Wibu-Systems CodeMeter T im e Serv er may be specified here.
You cannot specify your own NTP (Network Tim e Protocol) tim e servers here, as this tim e synchronization does not guarantee
a Certified Time, which plays an important role, for example, when retrieving and subsequently validating tim e-based licenses.
79
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Ele me nt D e scription
C o d eM eter Tim e Server S h ows a list o f Wibu-S ystems CodeMeter T ime Server allowing for an update o f the Certified T ime.
CodeMeter T ime Server ar e spe cif ie d e it he r as Int e rn e t addr e ss or IP addr e ss.
You e dit the CodeMeter T ime Server list by using the "ad d " or "rem o ve" buttons. You ch ang e t he
ord e r o f the list by using the "u p " and "d o wn " buttons.
Tim e O u t D efin e s the maximum re spons e pe riod for the CodeMeter T ime Server. The d efault value is 20 s e conds.
U se H TTP S Activate s H TT PS protocol for acce ssing CodeMeter T ime Server.
Click the "Ap p ly" button to save all the changes you have made. By a previous click on the "Restore Defaults" button you save
the default settings.
1.8.8.9 Trusted WebSocket Origins
On the "Configuration | Advanced | Trusted WebSocket Origins" page you are able to set local exceptions for checking trusted
WebSocket Origins.
Since CodeMeter Version 7.10a. by default, it is mandatory to check for the origin of a request when information and data is
exchanged via web components with CodeMeter License Serv er. This is done by certificates issued for these purposes.
The list Trusted WebSocket Origins allows to specify local exceptions for this check. This m eans that no certificates are required for
communication, or existing certificates are ignored.
Ele me nt D e scription
Tru sted Web So cket O rig in s S h ows a list o f local e xce ptions e ntrie s for che cking truste d We bSock e t Origins.
You e dit the list by using the "ad d " or "rem o ve" icons.
ad d n ew tru sted Web So cket Adds an e ntry for the list Tru sted Web So cket O rig in s.
Ente r the n e w truste d We bSock e t Origin.
O rig in
1.
Supporte d input formats are IPv4 and IPv6 addre ss e s and port spe cifications, e .g.
"http://localhost:4040 ", "http://[2001:db8::1%25eth0] " "https://
[2001:db8::1]:4040 ".
2. Click the Add button.
The e ntry displays in the list.
80
M anual
Cod eM eter Web Ad m in
In the list re sult you may d e le te e ntrie s using the re move icon.
Click the "Ap p ly" button to save all the changes you have made. By a previous click on the "Restore Defaults" button you save
the default settings, i.e local exceptions entries for checking trusted WebSocket Origins will be removed.
1.8.8.10 Extra
On the "Configuration | Advanced | Extra" page you configure som e additional advanced settings.
AP I Com m unication M od e
Here you define which communication mode CodeMeter License Serv er uses. Please proceed as follows:
1. Click the Ed it button.
2. Check the box to select the mode.
The following param eter are available:
CodeMeter -Ve rsion Prope rtie s
smalle r th an 4.40 '1 ' T CP/IP (D efault)
81
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Wibu-Systems recomm ends to use the relevant default settings, if no justified reasons suggest otherwise.
Alternatively, by editing registry or server entries you are also able to define which communication mode CodeMeter License
Serv er us es. The following tabl e s h ows you where for wh ich op erating system you find the pro filing to s et the communication
mode. The param eter Ap iCommunicationM ode. is available for setting the mode.
Ope rating syste m Re gistry / S e rve r Entry
Windows HKLM/SOFTWARE/WIBU-SYSTEMS/CodeMeter/Server/CurrentVersion
macOS /Library/Preferences/com.wibu.CodeMeter.Server.ini
Linux /etc/wibu/CodeMeter/Server.ini
3. Click the "Ap p ly" button to save the changes or "Restore D efaults" re storing the default s e ttings. Clicking the button
"Cancel" cancels the con figuration.
Network Ad vanced
Here you define som e advanced network settings. Please proceed as follows:
1. Click the Ed it button.
2. Enter the desired values in the respective fields.
The following param eter are available:
Please make sure you activated CodeMeter License Serv er for running as network server 69
.
Ele me nt D e scription
N etwo rk P o rt D efin e a n e twork port othe r th an the d efault port, if d e sire d.
N etwo rk Tim eo u t D efin e s the maximum re spons e pe riod for the CodeMeter Lice ns e S e rve r if running on a n e twork.
By d efault, th is value is 100 s e conds.
U D P Waitin g Tim e Spe cify the U D P Waitin g Tim e in ord e r to d efin e the pe riod in w h ich a UDP req ue st for e xisting
CodeMeter License Server on t he n e twork h as to r e ply. By d ef ault, t h is value is 1000 millis e conds.
Here you define the period of how additional license transfer activities are stored allowing you to obtain information on the PC
(host) to which the last transfer activity referred to.
Please refer as follows:
1. Click the Ed it button.
2. Enter the desired value in the respective field.
The following parameter are available:
82
M anual
Cod eM eter Web Ad m in
Ele me nt D e scription
Sto rag e o f ad d itio n al Licen se Spe cifie s the numb e r o f days lice ns e trans fe r in formation is save d.
Tran sfer in fo rm atio n
The d efault s e tting is 100 days.
4. Click the "Ap p ly" button to save the changes or "Restore D efaults" re storing the default s e ttings. Clicking the button
"Cancel" cancels the con figuration.
If you require, you are able to allow and activate modifying entry-specific settings of borrowed licenses.
Please note, that Prepared License Borrowing supports only Firm Codes smaller than 6.000.000.
1.8.9 Info
The "Info" page displays an overview of products and important Wibu-Systems addresses.
The License Transfer is supported for only, if using Universal Firm Codes with a number range bigger than 6.000.000.
· O f the Trans fer Typ es only the typ es Licenses (moving 'n' from 'm' licens es) and Borrow local license.
CodeMeter WebAdm in on various pages displays License Transfer Options and a History. Following tables list potentials items.
For a brief example of a license transfer of type "Licenses" ('n' from 'm' licenses) see here 84 and for the type "Borrow local license"
here 89 .
83
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
In the case of a license transfer activity, this table displays the actual values of the license transfer option.
Option D e scription
Licen se received fro m S e rial numb e r o f the CmContainers from w h ich a lice ns e h as b ee n re ce ive d.
P u llin g allo wed
Value D e scription
y es A lice ns e can b e active ly req ue ste d by a re ce iving CmContainer from a s e nding CmContainer.
no A lice ns e cannot b e active ly req ue ste d by a re ce iving CmContainer from a s e nding
CmContainer .
Sender
Receiver
84
M anual
Cod eM eter Web Ad m in
Receiver
Sender
85
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Receiver
License M onitoring
86
M anual
Cod eM eter Web Ad m in
Sender
Receiver
Receiver
87
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Sender
Receiver
88
M anual
Cod eM eter Web Ad m in
License M onitoring
Sender
Receiver
89
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Receiver
Sender
90
M anual
Cod eM eter Web Ad m in
Receiver
License M onitoring
91
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
1.8.10.22 Return
Cm Container Details
Sender
Receiver
Receiver
92
M anual
Cod eM eter Web Ad m in
Sender
Receiver
93
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
License M onitoring
Module Items are supported for only, if using Universal Firm Codes with a number range bigger than 6.000.000.
Module Items allow the organizational grouping of different license entries required for a product. This is especially helpful when using
the license transfer.
In the area "Licenses" of the Container navigation item existing Module Items display as arrow symbols ( ).
94
M anual
Cod eM eter Web Ad m in
95
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
No secret information is transferred to Wibu-Systems. You are able to check the information saved in plain text.
Open Cm D ust using the "Start | All Program s | CodeMeter | Tools" m enu item.
Press "Windows" key to open Start screen | Type "CmDust" | Press "Enter" key.
The result of the program execution is written to the text file CmDust-Result.log and saved to the user directory which
automatically opens when starting Cm D ust.
Alternatively, you are able to use the commandline application cmu 99 to create a log file.
For analyses this file can be sent to Wibu-Systems.
96
M anual
Cm D ust (Cod eM eter End user Sup p ort Tool)
Cm Dust on m acOS
For the operating systems Linux you create the Cm D ust file using the cm u 98
commandline program. Calling cm u is stored in the
search path.
1. Open cm u commandline
2. Type in the following command
cmu --cmdust
Using the option --file allows to add a nam e and a saving location.
By default, the file is written to the directory from which you accessed cm u.
3. Send this file for analyzing to Wibu-Systems.
Cm Dust outp ut
97
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
================================================================================
**************************** General Information *******************************
================================================================================
CmDust Version 4.40 Build 660 of 2011-11-10
Copyright (C) 2005-2011 by WIBU-SYSTEMS AG. All rights reserved.
Language Settings:
Machine: English
Current User: English
DataExecutionProtection state:
OPTIN (Only Windows system components and services have DEP applied.)
Current User has administrator rights
Press "Windows" key to open Start screen | Type "CodeMeter Command Prompt" | Press "Enter" key.
For the operating systems macOS and Linux this command is provided by the usual search path param eter.
The following list shows all existing cmu commands. A short example section is appended.
· G eneral s ettings 98
· CodeMeter T im e Serv er settings
100 100
· Exampl es 103
General setting s
98
M anual
CM U - Cod eM eter U niversal Sup p ort Tool
Command D e scription
/h or --help s h ows th is he lp in the commandlin e window.
/v or --version s h ows the ve rsions o f all available CodeMete r compon e nts.
/l or--list lists all conn e cte d CmContainer by way o f the ir s e rial numb e rs.
/x or --list- lists the conte nts o f all conn e cte d CmContainer .
content
/k or --list-server lists all available n e twork lice ns e s e rve r.
/n or –-list- lists the n e twork lice ns e in formation o f the own s e rve r.
network For e xplanations o f te rms, e .g. acce ss mod e s, ple as e s ee in formation on lice ns e monitoring 53 and te rms in
lice ns e display 40 in CodeMeter WebAdmin.
lists n e twork lice ns e in formation also o f re mote CodeMeter s e rve r.
-list-network [--server <servername>|--all-servers] [--serial <serial>] [--
firmcode <firmcode> [--productcode <productcode> [--featuremap <featuremap>]]]
--all-servers lists the n e twork lice ns e in formation for all found s e rve rs.
--server <servername> lists the n e twork lice ns e in formation for the spe cifie d s e rve r
<servername> .
--serial <serial> spe cifie d parame te r con figure the output according to crite ria s e le cte d.
--firmcode <firmcode>
--productcode
<productcode>
--featuremap <featuremap>
--add-server adds a s e rve r to the e nd o f your s e rve r s e arch list. As an argume nt pass the s e rve r's name , IP or CmWAN URL.
Example s:
server.domain.local
192.168.0.72
fe80::ea06:88ff:fecf:df6f
https://user:[email protected]/cmwan
--delete-server d e le te s a s e rve r from the s e rve r s e arch list. As an argume nt pass the s e rve r's name , IP or CmWan URL as it is
liste d.
-- clear- d e le te s all the e ntrie s from the s e rve r s e arch list. T o re activate automatic s e rve r broadcast, ple as e add
serversearchlist broadcast using option "--add-server 255.255.255.255 ".
--show- s h ows the e ntrie s in the s e rve r s e arch list.
serversearchlist
/c <FI> or -- cre ate s a lice ns e req ue st file (Conte xt File ) for Firm Item < FI> (s ee he re 103).
context <FI> Using option --file spe cifie s the output file . If no option is s e t the standard output is us e d (stdout).
/i or --import imports a lice ns e update file (Update File ) for the available CodeMete r lice ns e (s ee he re 103 ).
Using option --file spe cifie s the file name . The update can cove r a CmDongle or a CmActLicense lice ns e file .
/d or --firmware- starts the firmware update o f a CmContainer.
update
/u or --time-update starts the update o f the Ce rtifie d T ime in e ach conn e cte d CmContainer.
/e <s> or --enable allows the activation or d e activation o f the s e le cte d CmContainer. Spe cifying the CodeMete r password is
<s > req uire d.
The req uire d n e w Enabling status is spe cifie d by the parame te r <s>. Parame te r value s cove r 1 (disable ), 2
(te mporary e nable ), 3 (e nable ).
/t <no> or -- starts some simple te sts for e ach conn e cte d CmContainer. The numb e r o f te sts is spe cifie d by parame te r <no>.
test<no> It is req uire d th at the CmContainer must b e (te mporarily) e nable d.
/vv or --cmdust cre ate s a CmDust re port. Th is re port is us eful and req uire d w he n req ue sting support. Wibu-Syste ms
re comme nds to cre ate a CmDust re port b efore contacting the support.
Using the option --file write s the re sult into a te xt file .
--borrow allows the borrowing o f lice ns e s from a lice ns e s e rve r to the local PC. You h ave to spe cify the Firm Code and the
Product Code o f the lice ns e using the options --firmcode and --productcode . As an additional option you
may spe cify the Feature Map using the option --featuremap . More ove r, you h ave to spe cify the s e rial numb e r
o f the clie nt CmContainer and the s e rve r name using the options --serial and --server .
--return re turns the borrow e d lice ns e to the lice ns e s e rve r. You h ave to spe cify the Firm Code and the Product Code o f the
lice ns e using the options --firmcode and --productcode and the s e rial numb e r o f the clie nt CmContainer
and the s e rve r name using the options --serial and --server .
--borrowlist lists the borrow e d lice ns e s for the clie nt and the s e rve r.
--transferlist cre ate s a listing o f the lice ns e trans fe r re le vant data.
99
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Command D e scription
--enabling lists the e nabling stati o f all conn e cte d CmContainer.
Combin e d with the command –x you can also display additional e nabling in formation o f the CmContainer
conte nt.
--create-io is us e d in combination with the option --file and mak e s s e ns e only w he n using the h ardware form factors
CmCard/SD or CmCard/C F. A n e w codemtr.io f ile is cr e at e d.
--set-access-data activate s WebAdmin write authe ntication and save s the password. Us e with option --password to d efin e
password.
--set-proxy s e ts CodeMeter proxy con figuration. As argume nt pass the name or IP addre ss o f the proxy s e rve r.
A port diffe re nt to the d efault port (8 0) may b e d efin e d by --port follow e d by the port numb e r.
A us e r password authe ntication may b e s e t by --username <name of the user> --password
<password> .
T o re move the authe ntication us e --username follow e d by "".
--use-system-proxy on s e tting the proxy the syste m proxy is us e d.
In the pro filing or the server.ini file the n the e ntry
UseSystemProxy is s e t to a value o f 1 .
The e ntry h as the value 0, if --set-proxy is us e d.
Ple as e note , th at und e r Linux, the e nvironme nt
variable http_proxy is consid e re d as system proxy.
https_proxy is not ye t supporte d.
Example s:
cmu --set-proxy proxy.company.com --us e rname johndoe --password mypassword --port 90
cmu --set-proxy proxy.company.com --username ""
--reset-access- d e le te s both passwords for WebAdmin authe ntication (re ad- and write -passwords) and s e ts d efault (no re ad
data authe ntication, no write authe ntication). "Local Acce ss only" will b e s e t.
--device-id s e ts th is parame te r on import o f WibuCmLiF file s (--import ) with binding sche me "Binding Exte nsion".
The input o f the device-id is as 128 he x digits pre cee d e d by "0x".
--hid s e ts the USB communication standard to the Human Inte rface D e vice (HID) class spe cification.
S h ortcut for --set-config-disk HidCommunication .
May b e us e d with or with out spe cifying a s e rial numb e r via --serial .
With out spe cifying the command will b e e xe cute d for all conn e cte d CmDongle s.
--msd s e ts the USB communication standard to the Mass Storag e D e vice (MSD) class spe cification.
S h ortcut for --set -config-disk MsdCommunication .
May b e us e d with or with out spe cifying a s e rial numb e r via --serial .
With out spe cifying the command will b e e xe cute d for all conn e cte d CmDongle s.
CodeMeter Time Server Setting s
Please note that only Wibu-Systems CodeMeter T im e Serv ers may be specified here.
You cannot specify your own NTP (Network Tim e Protocol) tim e servers here, as this tim e synchronization does not guarantee
a Certified Time, which plays an important role, for example, when retrieving and subsequently validating tim e-based licenses.
--add-timeserver appe nds a single CodeMeter T ime Server to your T ime S e rve r list. As argume nt, pass the S e rve r name or IP
addre ss (IPv5 or IPv6).
--delete- d e le te s a single CodeMeter T ime Server from your T ime S e rve r list. As argume nt, pass the S e rve r name or IP
timeserver addre ss (IPv5 or IPv6).
--clear- re move s all e ntrie s from the CodeMeter T ime Server list.
timeserver-list
--set-timeserver- s e ts the CodeMeter T ime Server s e ttings to d efault parame te rs.
default · CodeMeter T ime Servers: cmtime.codemeter.com , cmtime.codemeter.de , cmtime.codemeter.us
· T ime out: 20 s e conds
100
M anual
CM U - Cod eM eter U niversal Sup p ort Tool
--add-timeserver appe nds a single CodeMeter T ime Server to your T ime S e rve r list. As argume nt, pass the S e rve r name or IP
addre ss (IPv5 or IPv6).
· Protocol: http
--show- s h ows the e ntrie s in the CodeMeter T ime Server list.
timeserver-info
--set-timeserver- s e ts the time out o f the CodeMeter T ime Server in s e conds.
timeout Value rang e is b e tw ee n 1 and 120. D efault value is 20 s e conds.
--set-timeserver- s e ts on e o f the protocols H TT P or H TT PS for CodeMeter T ime Server.
protocol
License transfer op tions
All calls existing in CodeMeter Core API for the licenses transfer feature can also be called using cm u. Here the respective files are
used (WibuCmLIF/WibuCmRaC/WibuCmRaU). The following cm u calls exist:
Command D e scription
--create-lt-context Enable s to cre ate a lice ns e trans fe r conte xt.
<parameters> Us e d with --lt-push parame te rs to spe cify the nature o f the trans fe r - lice ns e update with FSB if
omitte d.
Additional parame te rs:
--lt-request-file is a mandatory parame te r.
<file> It is us e d to spe cify the file <file> w he re the re sult o f the lice ns e conte xt
cre ation s h ould b e writte n.
--lt-context-file It is us e d to spe cify the file <file> containing the lice ns e conte xt to b e
<file> cre ate d.
--serial <serial> or s e le cts the CmContainer with the spe cifie d Serial Number.
-s <serial>
--firmcode <fc> s e ts the Firm Code o f the trans fe rre d lice ns e .
--productcode <pc> s e ts the Product Code o f the trans fe rre d lice ns e .
--create-lt-update Enable s to trans fe r a lice ns e trans fe r conte xt. Us e d with on e o f following parame te rs to spe cify the nature
<parameters> o f the trans fe r:
--lt-move-licenses the spe cifie d numb e r o f lice ns e s wil b e trans fe rre d.
<licenses>
--lt-borrow-local- e xpiration time as <YYYY>-<MM>-<DD>[T<hh>:<mm>:<ss>] (on e lice ns e
license <expiration will b e trans fe rre d for the spe cifie d time limit).
time>
--lt-renewborrow time validity o f an alre ady borrow e d lice ns e will b e e xte nd e d.
<expiration time>
Additional mandatory parame te rs:
--lt-request-file is a mandatory parame te r.
<file> It is us e d to spe cify the Conte xt File <file> containing the lice ns e conte nt to
b e trans fe rre d.
--lt-update-file is a mandatory parame te r.
<file> It is us e d to spe cify the Update File <file> w he re the re sult o f the lice ns e
trans fe r s h ould b e writte n.
--serial <serial> or s e le cts the CmContainer with the spe cifie d Serial Number.
-s <serial>
--firmcode <fc> s e ts the Firm Code o f the trans fe rre d lice ns e .
--productcode <pc> s e ts the Product Code o f the trans fe rre d lice ns e .
Additional optional parame te rs:
--lt-feature-code It is us e d to spe cify the Feature Code <number> . The d efault input for the
<number> <number> is in d e cimal unle ss it b e gins with 0x or 0X.
--lt-product-ref It is us e d to spe cify the Product Item Reference <number> . The d efault input for
<number> the <number> is in d e cimal unle ss it b e gins with 0x or 0X .
--import-lt-update Update s lice ns e trans fe r data on the targ e t sid e . Us e d with e ithe r --lt-push , --lt-pull , --lt-fsb
<parameters> or --lt-return parame te rs to spe cify the nature o f the trans fe r.
Additional parame te rs:
--lt-update-file is a mandatory parame te r.
<file> It is us e d to spe cify the Update File <file> w he re the re sult o f the lice ns e
update s h ould b e writte n.
101
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Command D e scription
--serial <serial> or optionally s e le cts the CmContainer with the spe cifie d Serial Number.
-s <serial>
--firmcode <fc> optionally s e ts the Firm Code o f the trans fe rre d lice ns e .
--productcode <pc> s e ts the Product Code o f the trans fe rre d lice ns e (optional, only with --
firmcode ).
--create-lt-receipt Cre ate s a signature with a d efin e d private k e y and give s it back as a re ce ipt to spe cify the nature the
<parameters> trans fe r.
Additional parame te rs:
--lt-receipt-file is a mandatory parame te r.
<file> It is us e d to spe cify the Conte xt File <file> w he re the re ce ipt will b e
trans fe rre d to.
--serial <serial> or s e le cts the CmContainer with the spe cifie d Serial Number.
-s <serial>
--firmcode <fc> s e ts the Firm Code o f the trans fe rre d lice ns e .
--productcode <pc> s e ts the Product Code o f the trans fe rre d lice ns e .
--import-lt-receipt Che cks the re ce ipt with a d efin e d public k e y con firming the validity o f a transaction. Us e d with on e o f
<parameters> following parame te rs to spe cify the nature o f the trans fe r.
Additional parame te rs:
--lt-receipt-file is a mandatory parame te r.
<file> It is us e d to spe cify the Conte xt File <file> w he re the data will b e trans fe rre d
from.
--serial <serial> or s e le cts the CmContainer with the spe cifie d Serial Number.
-s <serial>
--firmcode <fc> s e ts the Firm Code o f the trans fe rre d lice ns e .
--productcode <pc> s e ts the Product Code o f the trans fe rre d lice ns e .
--lt-cleanup Possible cle anup action
<parameters>
--deleted cle an d e le te d lice ns e s
--disabled cle an disable d (dang e rous)
--hiddenhistory cle an h istory o f give n product ite m
--container re move s w h ole lice ns e contain e r (dang e rous)
Additional parame te r
--serial <serial> or - s e le cts the CmContain e r with the spe cifie d S e rial N umb e r.
s <serial>
--firmcode <fc> s e le cts the Firm Code o f the trans fe rre d lice ns e .
--productcode <pc> s e le cts the Product Code o f the trans fe rre d lice ns e .
--lt-product-ref It is us e d to spe cify the Product Ite m Refe re nce <number> . The d efault input
<number> for the <number> is in d e cimal unle ss it b e gins with 0x or 0X.
102
M anual
CM U - Cod eM eter U niversal Sup p ort Tool
Options D e scription
/p <pwd> or --password Additional option in combination with the commands --enable and --firmware-update . Th is option
<pwd> d efin e s the req uire d CodeMeter Password for th is command.
--firmcode <fc> Additional option in combination with the commands --borrow or --return spe cifying the Firm Code o f
the borrow e d lice ns e .
--productcode <pc> Additional option in combination with the commands --borrow or --return spe cifying the Product Code
o f the borrow e d lice ns e .
--featuremap <fm> Additional option in combination with the commands --borrow or --return spe cifying the Feature Map
o f the borrow e d lice ns e .
--server <servername> Additional option to borrow a lice ns e from anothe r s e rve r. Is us e d in combination with command --
borrow .
--write Additional option us e d in combination with the command --detect-proxy w h ich save s the s e tting
using the CodeMeter pro filing. The s e s e ttings are writte n only if no proxy h as b ee n pre viously s e t in the
pro filing. For ove rwriting the s e ttings us e the option --force .
--force Additional option us e d in combination with the command --detect-proxy w h ich ove rwrite s alre ady
e xisting proxy s e ttings in the CodeMeterÒ pro filing.
--show-config-disk S h ows the curre nt s e ttings o f re movable /fixe d drive s or o f the type o f the d efin e d Maste r Boot Re cord
(MBR).
Th is option conce rns the b eh avior o f virtual flas h me mory partitions. Us e only for CmStick and CmStick/M.
--set-config-disk Allows to d efin e a spe cial b eh avior o f virtual flas h me mory partitions, e .g. drive s e ttings, boot cod e or
<parameter> activations (CmDongle only).
D e scription Parame te r
Drive s e ttings RemovableDisk,LocalDisk
Boot Cod e Int18Boot,ZeroBoot,LoopBoot,SwapBoot,VbrBoot
Activation ActivePartition,InactivePartition
FAT Fat16,Fat32
USB-Communication D e vice Class HidCommunication; MsdCommunication
--check-cm-integrity Allows to che ck the CodeMeter signature .
--licensing-terms Print lice nsing te rms o f GN U Le ss e r Ge n e ral Public Lice ns e (LGPL) 3.0.
--export-acl allows you to e xport the list o f Lice ns e Acce ss P e rmissions (ACL, Acce ss Control List).
Ple as e us e the --file 98 option to spe cify the file name .
The spe cification o f absolute path s is supporte d. If no path is spe cifie d, the file is locate d in the local
dire ctory.
The e xport is possible during ope ration, the CodeMeter WebAdmin s e rvice do e s not h ave to b e stoppe d or
starte d s e parate ly.
The list is e xporte d in *.json format. N o file e xte nsion must b e spe cifie d. The file is e ditable . For
in formation about format conve ntions to b e us e d ple as e contact Wibu-Syste ms Support.
Curre ntly th is command is only supporte d for Windows ope rating syste ms. A support o f T riple Mod e
Re dundancy (T MR) is curre ntly not imple me nte d.
--import-acl allows you to import the list o f Lice ns e Acce ss P e rmissions (ACL, Acce ss Control List).
Ple as e us e the --file 98 option to spe cify the file name .
The spe cification o f absolute path s is supporte d. If no path is spe cifie d, the file is locate d in the local
dire ctory.
The import is possible during ope ration, the CodeMeter WebAdmin s e rvice do e s not h ave to b e stoppe d or
starte d s e parate ly.
The list is importe d in *.json format. N o file e xte nsion must b e spe cifie d. The file is e ditable . For
in formation about format conve ntions to b e us e d ple as e contact Wibu-Syste ms Support.
Curre ntly th is command is only supporte d for Windows ope rating syste ms. A support o f T riple Mod e
Re dundancy (T MR) is curre ntly not imple me nte d.
Action Parame te r
Displaying cmu options Cmu[32].exe -h
Cre ating a CodeMete r Re mote Activation Conte xt File (he re :1- Cmu[32].exe -c10 -f1-140870.WibuCmRaC
1040870.WibuCmRaC ) for the Firm Code 10 (Firm Item level)
103
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Action Parame te r
Importing a CodeMete r Re mote Activation Update File (he re :1- Cmu[32].exe -i -f1-1040870.WibuCmRaU
1040870.WibuCmRaU ) --> re programs the conn e cte d
CmContainer
S h owing the ve rsions o f curre nt CodeMete r compon e nts. cmu[32] --version
Listing all available CodeMeter n e twork lice ns e s e rve r and if e xisting cmu[32] --list-server --list-content
all re late d lice ns e s.
Starting 100 simple te sts. The te sts are e xe cute d only for the cmu[32] --test 100 --serial 1-233232
CmContainer spe cif ie d by t he s e rial numb e r o f 1-233232 .
Ch anging the e nabling status to "temporarily enabled" for the cmu[32] --enable2 --serial 1-2345 --password
CmContainer 1-2345 by using t he CodeMete r password "SECRET". SECRET
Starting with Version 5.20 CodeMeter supports Secure License Tracking. This ensures that license access log data is written
manipulation-safe. Manipulation is prevented by authenticated check of data integrity using signatures.
For analyzing license access data not a single log file is created but separate logfiles for each Firm Code. Integrity and authenticity of
the log files preventing tampering is ensured by signatures and a subsequent signature check.
Valid ation
In order to validate either the contents of a given signed CodeMeter log file or a sequence of log files located in a given directory use
the option in Cm BoxPgm the developer tool for local programming of Cm Container using a commandline (console).
Command /vslf - Validation O f Sign e d Log File s
Validate s e ithe r the conte nts o f a give n sign e d CodeMeter log file or a s eq ue nce o f log file s locate d in a give n dire ctory.
Expe cts the path to the file th at contains the public k e ys to us e for validation and the path to the log file re spe ctive ly log
dire ctory as argume nts.
Syntax /vslf:<public key file>,<log file>|<log directory>
The <public key file> musst b e cre ate d as comma s e parate d file (CS V).
For th is file the following notation is valid:
<major version>,<minor version>, <firm code>, Ox<public key>
You can spe cify s e ve ral diffe re nt value s and public k e ys for s e parate runtime ve rsions.
You obtain the req uire d value s from on e o f the cre ate d CodeMeter log file s.
From the CodeMeter log file :
2014-06-24T06:06:19 SignedLogfile FirmCode:10,
PublicKey:a809304778d517c44a22d65e1fcedd51a4e2a956fa89e93bb1a24e2100000000a2ad17e685306d
6e15eb6b7ebc8cc72ebc97c0f52721b584836696de00000000, Runtime-Version:5.20.1432.500,
LogfileID:1
the following <public key file> is d e rive d:
5,20,10,0xa809304778d517c44a22d65e1fcedd51a4e2a956fa89e93bb1a24e2100000000a2ad17e685306d
6e15eb6b7ebc8cc72ebc97c0f52721b584836696de00000000
Currently, the logfile content is saved locally but for future version its is planned that contents may also be retrieved using HTTP
access and calls (real-tim e history).
If the logfiles need to be read from other systems, you must share the folder where the logfiles are stored as read-only in your
local area network.
The following sections briefly:
· s how how to configure Licens e Tracking
104
104
M anual
Cod eM eter License Tracking
The logging of licensing data must be activated together with CodeMeter License Serv er. This you do by direct activation in the
CodeMeter Pro filing environm ent.
P rofiling
For Windows operating systems you find the profiling entries stored in the registry, for other operating systems entries are set in the
file server.ini. The following table shows you the respective locations.
Ope rating syste m Re gistry / S e rve r.ini Entry
Windows HKLM/SOFTWARE/WIBU-SYSTEMS/CodeMeter/Server/CurrentVersion
macOS /Library/Preferences/com.wibu.CodeMeter.Server.ini
Linux /etc/wibu/CodeMeter/Server.ini
The following relevant profiling entries for License T racking exist.
Entry Prope rty
Value
LogLicenseTracking [DWord] [0;1]
Please note that you must stop the CodeMeter License Serv er service, make the change, and then restart the CodeMeter
License Serv er s ervice b efore the ch ang e can take effect.
CodeMeter License Serv er is registered as a Windows service and can be started with user privileges. For stopping the
service, however, you need administrator privileges under Windows (System Settings | Managem ent | Services).
105
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
In order to manage the constant growth of log files efficiently, CodeMeter offers a rotating system in the area of license tracking.
This system can be set via two param eters in profiling.
· LogLicenseTrackingLogRotationSizeInMb
If a license tracking log file exceeds a size of x MB, the rotation starts.
The input range of x is from 1 to 3500 MB.
· The default value is 1000 MB.
If the specified value is outside the input range, automatically the default value applies.
· LogLicenseTrackingLogRotationTimeInMinutes
If the oldest entry of a license tracking log file is older than n minutes, the rotation should start.
The input range of n is from 0 to 525600 minutes (approx. 1 year).
Please note that after specifying n, the log file starts to rotate after a tim e delay of about 1 minute.
The default value is 0 minutes. Then tim e-based log rotating is deactivated.
If the specified value is outside the input range, automatically the default value applies.
1.11.2 Logfile Format
The following logic applies to the format of the logfile.
1. Each line in the logfile can be handled separately. There exist separate lines for different entry types . 107
2. Each line that does not match to the described formats has to be ignored.
This will allow us to enhance the output in future versions without causing trouble in working solutions.
It is also recomm ended to do a parsing of the different argum ents of a line and simply to ignore argum ents that are not
known.
This allows us to enhance the output in future versions without causing trouble in working solutions.
application ID [0..4294967295]
application text string
enabling block index [0..31]
expiration time ["never"|UTC Timestamp]
feature map [0..4294967295]
firm code [0..4294967295]
hash string
license ID string
The <license ID> is automatically d e rive d as <mask>-<serial number>-<firm
code> -<product item reference> , e .g. “2-1500002-100532-18 ”. The <license
ID> is a uniq ue ID e ntifie r for a lice ns e e ntry.
license quantity [0..4294967295]
list of hashes string
logfileID [0..4294967295] ID value o f the log file .
In ord e r to pre ve nt th at a single or s e ve ral log file s can b e d e le te d e ach log file must h ave a s e parate
ID.
mask [0..65535]
namelist id [1..4294967295]
106
M anual
Cod eM eter License Tracking
Since the strings may contain quotation marks (") but may also be bracketed expressions, any quotation marks that are part
of the string are quoted by a backslash (\). For example, the application text The best of "John D oe." will be issued as
...AppText: "The best of \"John Doe.\""
Access 108
Release 108
Administrative 109
SignedLogfile 109
Signature 109
In the cas e s me ntion e d above , all License e ntrie s o f the curre nt s e rve r are writte n pre ce d e d by a List of
Licenses 107 e ntry.
107
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Before all License entries are re-written on changing entries all allocated licenses are released by a Release entry. Imm ediately after
issuing the License entries the previously released licenses are again allocated by an Access entry.
This is necessary because license IDs can change on re-programming or on plugout and the subsequent rebooking. Moreover,
the access ID may change by automatic rebooking after plugout.
Licenses with a License Quantity value of 0 (license for local use use) are not listed.
The Expiration Time contains the minimum of the Product Item Option Expiration Time and the value of an activated Product Item
Option Usage Period. If neither an Expiration Time is set nor a Usage Period exists or is activated the value is “never”.
1.11.3.3 Access Entry
Entry type Access e ntry
D e scription An Access e ntry d e scrib e s th at a lice ns e on a s e rve r is allocate d to a us e r.
Writing time The Access e ntry is writte n at the mome nt a lice ns e is acce ss e d.
Syntax <timestamp> Access Server:"<server>", LicenseID:<license ID>, AccessID:<access
ID>, Client:"<computer name>", User:"<user name>", AppID:<application ID>,
AppText:"<application text>"
The application ID and application text are derived from CMCREDENTIAL structure using mulUserDefinedID and
mszUserDefinedText.
108
M anual
Cod eM eter License Tracking
If CodeMeter License Serv er is stopped, all Access e ntrie s are automatically canceled. Only Borrow Access entries remain valid
and will be restored on next start of CodeMeter License Serv er. Usually, the Release entries are automatically added to the log,
but in som e circumstances this is not possible, e.g. killing CodeMeter License Serv er.
109
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
2014-02-07T10:34:43 Signature
Signature:75998652881c0c56ce7b391c3638c1a5540e12cab282e2c3c82a0a0a000000008cf46fd7a025939b7d
86dfff8b4bdc01073da2eed7326bc351a335cb00000000
The communication class HID is available for many Cm D ongle. Please consult the respective data sheet for support details.
Re q uirem ents
· Minimum CodeMeter Firmware 2.02
· Minimum CodeMeter Runtim e 5.0
The USB communication standard can be switched any tim e from Mass Storage Device (MSD) to Human Interface Device (HID) or vice
versa.
1.12.1 Set from Mass Storage to HID
To switch the USB communication standard from Mass Storage Device (MSD) to Human Interface Device (HID), please proceed as
follows:
1. View the status in CodeMeter WebAdm in on page " ".
Content | CmContainer
2. Call cm u 98
.
For Windows OS call cm u call cm u by the start m enu item "Start | All P rograms | CodeM eter | Tools | CodeM eter Command
P romp t" ( Press "Windows" key to open Start screen | Type "CodeMeter Command Prompt" | Press "Enter" key). For the
operating systems macOS and Linux this command is provided by the usual search path param eter.
3. Enter the following commandline:
cmu32 /s [Box mask-Serial number] --set-config-disk HidCommunication
The current status displays in the following commandline output:
cmu32 - CodeMeter Universal Support Tool.
Version 5.00 of 2013-Jan-30 (Build 1039) for Win32
Copyright (C) 2007-2013 by WIBU-SYSTEMS AG. All rights reserved.
Virtual Drive: E:
Configuration: LocalDisk with ActivePartition
File System: FAT32
Communication: Mass Storage Device
Boot-Code: Int18 Boot Code
Mdfa: 0x539
111
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
2. Call cm u 98
For Windows OS call cm u call cm u by the start m enu item "Start | All P rograms | CodeM eter | Tools | CodeM eter Command
P romp t" ( Press "Windows" key to open Start screen | Type "CodeMeter Start Center" | Press "Enter" key). For the operating
systems macOS and Linux this command is provided by the usual search path param eter.
3. Enter the following commandline:
C:\Users\fs>cmu32 /s [Box mask-Serial number] --set-config-disk MsdCommunication
The current status displays in the following commandline output:
cmu32 - CodeMeter Universal Support Tool.
Version 5.00 of 2013-Jan-30 (Build 1039) for Win32
Copyright (C) 2007-2013 by WIBU-SYSTEMS AG. All rights reserved.
112
M anual
H ID Sup p ort
CmCard via AT A:
CONFIG_SYSFS
CONFIG_BLK_DEV_SD
CONFIG_ATA + re spe ctive AT A Host adapte r/controlle r
CONFIG_BLK_DEV_SG (for passth roug h communication)
CONFIG_*_FS (for file I/O, the re spe ctive file syste m)
113
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
1.13 Open Source Software used in the products CodeMeter 7.20b, CodeMeter Protection Suite
10.70b, CodeMeter Embedded 2.51a as of 2021-04-28
Open Source Software used (embedded in local help system)
114
Glossary
2 Glossary
Te rm D e scription
AxP rotector Automatic prote ction o f applications using AxP rotector as s e cure basic prote ction with out ch anging the
source cod e including runtime che cks, effe ctive anti-d e bug me ch anisms, modification o f re source s, and
locking o f CmContainer if crack atte mpts are d e te cte d. As tool o f CodeMeter P rotection Suite available for
diffe re nt pro je ct type s and as a commandlin e ve rsion.
CmActLicense Comple te ly so ftware -bas e d variant o f the prote ction and lice nsing te ch nology CodeMeter. Lice ns e s are
bound to an individual compute r.
CmBo xP gm Commandlin e tool to cre ate , e dit, and d e le te lice ns e s and the ir compon e nts (Firm Item , Product Item , and
Product Item Options ) in CmContainer. You can also apply scripts and batch file s for mass production and te st
automation. Programming is simultan e ously applie d in on e pass e to s e ve ral CmContainer.
CmCloudContainer Cloud-bas e d variant o f the prote ction and lice nsing te ch nology CodeMeter. End us e rs can acce ss th is
CmCloudContainer f rom t he ir local comput e r wit h appropriat e cr e d e ntials. Th is also me ans t h at only t he
cre d e ntials are on the local compute r, w h ile the CmCloudContainer and the lice ns e s are in the cloud.
CmContainer Summarizing notion for d e scribing the lice ns e carrie rs o f all CodeMeter variants. CmDongle in the cas e o f
the h ardware -bas e d lice nsing syste m, CmActLicense n the cas e o f the so ftware -bas e d lice nsing syste m,
and CmCloudContainer in the cas e o f the cre d e ntial-bas e d lice nsing syste m.
CmDongle Hardware -bas e d variant o f the prote ction and lice nsing te ch nology CodeMeter. Available in many form
factors for a varie ty o f inte rface s.
CmDust The CodeMeter Endus e r Support T ool logs important syste m and CodeMeter s e ttings and he lps Wibu-
Syste ms Support to find re me die s for e ve ntually occurring e rrors.
F
Cm AS see CodeMeter Field Activation Service
cmu Commandlin e alte rnative to pe rform many CodeMeter Control Center functions (CodeMeter Universal
Support T ool).
CodeMeter A PI Guide Graph ical tool to g e n e rate source cod e fragme nts. You cre ate and te st API functions with all re late d
parame te rs and n e ce ssary structure s for the programming languag e o f your ch oice . Curre ntly, the
programming languag e s C, C++, C#, CB6, VB.N E T , D e lph i, and Java are supporte d.
CodeMeter Certi icatef Vault works as a PKCS #11 compliant tok e n provid e r, inte grating with the Microso ft Cryptograph ic API Ne xt
Ge n e ration (CN G) as a Ke y Storag e Provid e r (KSP), and working with Ope nSSL API e .g. to k ee p and us e
the k e ys for T LS ce rtificate s. It is fully inte grate d with many e ss e ntial applications including brows e rs,
VP N s, and e mail.
CodeMeter Field Activation s ee File -based Remote P rogramming
Service
CodeMeter Control Center CodeMeter Control Center provid e s the prote cte d so ftware to acce ss the CodeMeter runtime
e nvironme nt. It displays in formation on conn e cte d CmContainer, and pre s e nts options to con figure
conn e cte d CmContainer. More ove r, an assistant cre ate s lice ns e req ue st file s and imports lice ns e update
file s (CmFAS Assistant).
CodeMeter Ke yring Prote ction solution bas e d on us e r and password cre d e ntials cre ate d in the P assw ord Manager
compon e nt and supplie d by the P assw ord P rovider compon e nt.
P assw ord Manager conn e cts to CodeMeter License Central a fte r startup and re trie ve s the con figure d us e rs
and passwords from it. The re is no local data storag e . Cre ate d passwords and us e rs are us e d in P assw ord
P rovider, e .g. for imple me nting the fe ature o f prote cting the source cod e .
CodeMeter License Central T ick e t-bas e d syste m for cre ating, managing, and d e live ring lice ns e s for so ftware and digital conte nt.
Available in a Desktop and an Internet Edition.
CodeMeter License E ditor Graph ical tool allowing you to cre ate , e dit or d e le te lice ns e s and the ir compon e nts (Firm Item , Product Item ,
and Product Item Options ) in CmDongles. Ne xt to programming o f locally conn e cte d CmCongles also file -
bas e d re mote programming (CodeMeter Field Activation Service , CmFAS) is supporte d. Suitable for te sting
lice ns e strate gie s.
CodeMeter License Server Runtime e nvironme nt (CodeMeter.exe ) for the prote ction and lice nsing te ch nology CodeMeter.
CodeMeter Start Center Start scree n tool to acce ss and ope n most o f the CodeMeter applications and tools.
CodeMeter P rotection Suite T oolbox for the automatic e ncryption o f applications and librarie s. The individual tools h ave b ee n tailore d
spe cifically to work with e ach platform or e nvironme nt (s ee AxP rotector, IxP rotector).
CodeMeter WebAdmin Graph ical CodeMeter tool displaying in formation on conn e cte d CmContainer and re late d lice ns e e ntrie s in
a brows e r. In addition, con figuration and analyzing options for the CodeMeter runtime e nvironme nt
(CodeMeter License Server) are provid e d.
CodeMeter Wibu-Syste ms' te ch nology for prote cting and lice nsing o f so ftware and digital conte nt.
File -bas e d Re mote Re mote updating a CmContainer req uire s some in formation on the CmContainer to b e re programme d.
Programming Th is in formation is sa fe ly store d and trans fe rre d in a Conte xt File , i.e . *.WibuCmRaC file (lice ns e req ue st
file ). Bas e d on th is lice ns e req ue st file us e the CodeMeter programming tools to cre ate an Update File
(*.WibuCmRaU ) (lice ns e update ). Subs eq ue ntly, th is file is sa fe ly trans fe rre d into the CmContainer. In
addition, on cre ating the *.WibuCmRaU file automatically also a *.WibuCmRaM file (Modifie d Conte xt
115
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Te rm D e scription
File ) is cre ate d w h ich maps the CmContainer conte nt at the time the lice ns e s h ave b ee n update d.
An CmFAS Assistant in CodeMeter Control Center supports the lice ns ee w he n updating lice ns e s.
Firm Code The Firm Code pre s e nts a uniq ue numb e r e ach lice nsor re ce ive s from Wibu-Syste ms. It e nsure s th at e ach
lice nsor is individually id e ntifie d w he n prote cting and lice nsing so ftware or digital conte nt.
Firm Item Logical and h ie rarch ical ite m le ve l in the CmContainer. The Firm Item le ve l h olds e ntrie s w h ich are uniq ue for
e ach lice nsor and includ e s the individual Firm Code.
Firm Key S e cre t k e y w h ich in flue nce s almost all e ncryption and d e cryption proce ss e s o f lice ns e s, the ir
authe ntication, and the cre ation, e diting and d e le ting o f lice ns e e ntrie s at the le ve l o f Product Items . The
Firm Key is initially s h ippe d with the Firm Security Box .
Firm Security Box Maste r CmDongle w h ich allows to program othe r CmContainer. The FSB is uniq ue for e ach lice nsor.
FSB s ee Firm Security Box
HIP High Level P rogramming API s ee P rogramming API
IFI s ee Implicit Firm Item
Implicit Firm Item The Implicit Firm Item le ve l in the CmContainer fe ature s the same ch aracte ristic as usual Firm Items ). It simply
h as some distinct fe ature s. Wh ile all othe r le ve l are ch aracte rize d by the e xiste nce o f an e xclusive Firm Code
w h ich is uniq ue for e ach lice nsor, the Implicit Firm Item le ve l h as the Firm Code o f 0. Th is implie s th at e ach
own e r o f the CmContainer h as lice nsor privile g e s for the Implicit Firm Item le ve l including write acce ss.
IP P rotection Prote ction solution o f CodeMeter P rotection Suite with out lice nsing, i.e . re ve rs e e ngin ee ring is pre ve nte d,
but not copying the application. Th is mak e s th is solution suitable for te st ve rsions, d e mo so ftware and
free mium busin e ss mod e ls, since prote cte d applications do not req uire runtime compon e nts o f
CodeMeter . The k e y f or d e crypting t he application is h idd e n in t he application its e lf . N ot to b e con f us e d
with P rotection Only lice ns e s. The s e works similar to IP P rotection, but always req uire a CodeMeter Runtime
installe d with administrator rig h ts.
IxP rotector Individual advance d prote ction te ch nology applie d for so ftware and digital conte nt as tool o f CodeMeter
P rotection Suite . 'Re al' source cod e fragme nts are e ncrypte d and d e crypte d by inte rface s (Softw are
P rotection API, WUPI) and s e curity me ch anisms. Suite d to imple me nt modular so ftware prote ction.
Core A PI Pow e rful inte rface to communicate with CmContainer at runtime o f CodeMeter License Server. All othe r
APIs and prote ction me ch anisms (AxP rotector, IxP rotector, Softw are P rotection API WUPI) bas e on Core API
functions. Th us using th is inte rface comple me nts e xisting prote ction options (e ncryption and d e cryption
o f data, pe rsonalization, re ading additional data).
Lice ns e Activation s ee File -bas e d Re mote Programming
Lice ns e In formation File Th is file corre sponds for CmActLicense to an e mpty lice ns e contain e r h ow e ve r h olds spe cifications on
(*.WibuCmLiF ) binding sche me s and additional activation options to b e us e d for uniq ue binding o f a lice ns e to the
compute r or the d e vice .
Update File (lice ns e update ) The Update File for a CmContainer valid only for a single uniq ue CmContainer can b e importe d only once .
(*.WibuCmRaU )
Conte xt File (lice ns e req ue st) The Conte xt File o f a CmContainer mirroring the as-is status o f lice ns e e ntrie s s e rve s as basis for lice ns e
(*.WibuCmRaC ) updating in the proce ss o f file -bas e d (re mote ) programming.
CodeMeter SmartBind Binding sche me us e d in CmActLicense lice nsing syste m optimize s assuring the validity o f CmActLicense
lice ns e s, if h ardware prope rtie s o f the PC ch ang e to w h ich the lice ns e s are bound.
PIO s ee Product Item Options
Product Code The Product Code re pre s e nts a numb e r free to ch oos e and id e ntifie s the products to b e prote cte d and
lice ns e d.
Product Item Options (PIO) Lice ns e e ntrie s at the Product Item le ve l. The y h old the Product Code also furthe r options d efining the actual
ch aracte ristics o f a lice ns e , such as, h ow many lice ns e s may b e simultan e ously us e d in a n e twork, h ow
long a lice ns e is valid, w h ich functions are acce ssible and bille d, e tc. More ove r, s e ve ral othe r data fie lds
are available h olding additional binary in formation and diffe r in the ir acce ss privile g e s.
The s e optional ch aracte ristics are combinable in a varie ty o f ways, and constitute the basis for the
mapping o f any imaginable lice ns e strate gy.
Product Item Logical h ie rarch ical e ntry le ve l in a CmContainer b e low the Firm Item le ve l. At the Product Item le ve l you find
the single lice ns e e ntrie s, i.e . the Product Codes and furthe r Product Item Options .
P rogramming API Th is class-orie nte d inte rface allows you to acce ss any ob je ct or proce ss req uire d to program or organize
lice ns e e ntrie s in a CmContainer, and fe ature s e xte nd e d customizing for the inte gration o f CodeMeter
into own applications. The P rogramming API is available for many programming languag e s.
So t f w are P rotection API Inte rface w h ich d e crypts s e gme nts prote cte d by IxP rotector at runtime available as WUPI (WIBU Universal
P rotection Interface ). It is le an, compris e s only a fe w but e ss e ntial functions, and is standardize d and
applicable for a varie ty o f programming languag e s.
So ft lice ns e s ee CmActLicense .
T ranslocate d Exe cution AxP rotector supports t he t e ch niq ue to translocat e , i.e . s h if t t he e xe cution o f s e le ct e d f unctions to ot he r
116
Glossary
Te rm D e scription
arbitrary proce ssing are as. At the same time , the data at the original location is not ch ang e d.
Wibu Universal P rotection s ee Softw are P rotection API
Interface
WUPI s ee Wibu Universal P rotection Interface
117
Cod eM eter Ad m inistrator M anual 7.20b - Ap ril 2021
Profiling 41, 82
Location different operating system s 104
-R-
Receipt 39
-S-
Secure License Tracking 104
Server Search List 60
*.ini configuration file 60
Server search list - automatic server search 61
Shared Memory 41, 82
System startup
CodeMeter License Server 5
-T-
TCP/IP
Use in CodeMeter 41
-W-
wbb file (CmActLicense) 6
Write Filter (EWF, FBWF) 16
119