Dongle Guide
Dongle Guide
Copyright Notice
Copyright © 2015 Flexera Software LLC. All Rights Reserved.
This product contains proprietary and confidential technology, information and creative works owned by Flexera Software LLC and its licensors, if
any. Any use, copying, publication, distribution, display, modification, or transmission of such technology in whole or in part in any form or by any
means without the prior express written permission of Flexera Software LLC is strictly prohibited. Except where expressly provided by Flexera
Software LLC in writing, possession of this technology shall not be construed to confer any license or rights under any Flexera Software LLC
intellectual property rights, whether by estoppel, implication, or otherwise.
All copies of the technology and related information, if allowed by Flexera Software LLC, must display this notice of copyright and ownership
in full.
Intellectual Property
For a list of trademarks and patents that are owned by Flexera Software, see http://www.flexerasoftware.com/intellectual-property. All other brand
and product names mentioned in Flexera Software products, product documentation, and marketing materials are the trademarks and registered
trademarks of their respective owners.
1 FlexNet ID Dongles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
About FlexID Dongles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Purpose of This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Supported FlexNet ID Dongles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Mapping of Previous Installers to Current Installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Multiple Dongle Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Dongle Installers and Shared object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
FlexNet ID Dongle
This manual describes how to install the drivers required on systems where FlexNet ID dongles are used to anchor
license rights to a machine.
Topic Content
FlexNet ID Dongles Provides an overview of this manual and includes details of new features in
this release.
Installing Dongle Drivers on Instructions for installing the dongle drivers on Windows platforms.
Windows
Installing Dongle Drivers on Instructions for installing the dongle drivers on Mac.
Mac
Installing Dongle Drivers on Instructions for installing the dongle drivers on UNIX platforms.
Linux
Testing the Dongle Driver How to test that a dongle driver is installed correctly.
Installation
FlexNet ID Dongle FAQ and Provides few FAQs and troubleshooting scenarios.
Troubleshooting
FlexNet dongles are normally used with license rights that are held in license files, and this document assumes that
this is the case in all examples.
For the FlexNet dongle to communicate with the computer it is attached to, the appropriate drivers must be
installed on the computer. Drivers are specific to a given platform and operating-system version. Therefore, you
might need to download and provide updated drivers for existing products when new operating-system versions are
released. The latest drivers are packaged with the current release version of the FlexNet Publisher Licensing toolkits
and are also available from specific download Flexera Software sites.
You must always install the drivers for the FlexNet ID dongles using the files provided by Flexera Software. Do not
install drivers from any other source (for example, from an automatic search and download).
Further information on using FlexNet dongles is provided in the documentation supplied with your Licensing toolkit.
Depending on the version of the toolkit you are using, information about FlexNet dongles is provided in the
following FlexNet Publisher documents:
• FLEXID – The license server does not check for virtualization when attempting to extract the FLEXID. Normally it
means a physical machine, but could also mean a virtual machine where the hypervisor supports USB pass-
through. For VMWare USB dongle pass-through support, refer http://kb.vmware.com/selfservice/microsites/
search.do?language=en_US&cmd=displayKC&externalId=1021345
• 10.7
• 10.8
• 10.6
• 10.7
• 10.8
Note • FLEXID 9 dongles on all Windows platforms use the SRM driver (version 7.0).
• Up to SUSE 12.1
Insta
ller Installer With Installer With Installer With
Operating FLEXID Chan FlexNet Publisher FlexNet Publisher FlexNet Publisher
System Type ge 11.12.1 11.13.0 11.13.1 and later
FLEXID 9 Windows 32 bit Multiple (one HASP4 Multiple (one Multiple (one
+ multiple HASP HL) HASP4 + multiple HASP4 + multiple
HASP HL) HASP HL)
2. Or you can set the newly introduced environment variable FLEXID_LIBRARY_PATH to specify the location of the
dongle library path.
3. When setting the FLEXID_LIBRARY_PATH environment variable, manually copy the dongle dlls:
When FLEXID_LIBRARY_PATH environment variable is not set the default location for the dongle library would be:
• c:\windows\system32
• c:\windows\sysWOW64
• /usr/lib
Note • If the FLEXID_LIBRARY_PATH exceeds 255 characters one of the following error message is displayed:
• The "FLEXID_LIBRARY_PATH" path for Wibu exceeded the max limit of 255 characters!
• The “FLEXID_LIBRARY_PATH” path for Aladdin exceeded the max limit of 255 characters!
Where To Start
If you are installing FlexNet ID dongle drivers for the first time on a machine, use the instructions in Install or
Remove Current Dongle Drivers.
If you are replacing older drivers (previous to FlexNet Publisher 11.11.1) with the current versions, best practice is
first to remove the older drivers as described in Remove Pre-11.11.1 Dongle Drivers; then install the new drivers as
described in Install or Remove Current Dongle Drivers.
If you have installed a current driver and want to remove it, follow the instructions in Install or Remove Current
Dongle Drivers.
Caution • If any of the dongle drivers were updated by Windows Update, remove them using only tools provided by the
dongle manufacturer. See the dongle manufacturer’s Web site for details.
Uninstall Using
FLEXID_Dongle_Driver_Installer.exe
1. At a command prompt from the directory where the driver installer resides, run the following command:
FLEXID_Dongle_Driver_Installer.exe /remove
Note • You have the option to use the command line to uninstall these drivers. You must do so in silent mode (for
example, FLEXID_Dongle_Driver_Installer.exe /s /remove).
Access Add or Remove Programs (or the appropriate tool) from your Windows Control Panel, select the dongle
drivers to remove, and click Uninstall.
• Install the driver file before plugging the dongle in to your machine. Plugging in the dongle before installing
the driver can cause an automatic search for driver files. The driver files found by an automatic search might not
be compatible with FlexNet ID dongle.
• Use the methods described in this section to install the current versions of the dongle drivers. Do not allow
Windows Update to install these drivers. Such an update can lead to unpredictable behavior of the dongles with
FlexNet Licensing software.
• When using the command line (instead of the user interface) to install or remove a driver, you must use the
silent mode.
1. Locate the.zip file for the appropriate Windows dongle-driver installer within your FlexNet Publisher licensing
toolkit; or download the installer from the FlexNet Publisher download site. (For example, publishers download
from the Flexera Software Product and License Center: https://flexerasoftware.flexnetoperations.com. End-users
should contact Flexera Software for the appropriate download site.)
At a command prompt from the directory where the dongle-driver installer resides, enter the following:
haspdinst.exe -i
At a command prompt from the directory where the dongle-driver installer resides, enter the following:
haspdinst.exe -i -nomsg
Important • The new Safenet external license manager (hasp_rt.exe) is now required to be placed in the same folder
of FNP dongle protected applications (including lmhostid, vendor daemon, lmtools and lmadmin). If hasp_rt.exe does
not exist in the same folder, an unexpected Safenet error dialog, referring to the SafeNet 'hasp_cleanup' API may
appear when FLEXID9 Safenet runtime driver is not installed on the machine, but, the dynamic library (haspsrm_*.dll)
is copied to system32/SysWow64 folder. Refer to Dongle Installers and Shared object.
At a command prompt from the directory where the dongle-driver installer resides, enter the following:
haspdinst.exe -r
At a command prompt from the directory where the dongle-driver installer resides, enter the following:
haspdinst.exe -r -nomsg
At a command prompt from the directory where the driver installer resides, enter the following:
haspdinst.exe -?
ForceOverrite=0
Gui=1
ErrorMessages=1
2. At a command prompt from the directory where the dongle-driver installer resides, enter the appropriate
command.
SETUP32.exe
SETUP64.exe
4. Click “Next”, starts the copy and setup process. Click “Next” through the wizard, and then click Finish.
Note • Failure to reboot once you install the driver can cause problems with the driver working properly.
ForceOverrite=1
Gui=0
ErrorMessages=0
2. At a command prompt from the directory where the dongle-driver installer resides, enter the appropriate
command.
SETUP32.exe
Note • Failure to reboot once you install the driver can cause problems with the driver working properly.
Access Add or Remove Programs (or the appropriate tool) from your Windows Control Panel, select WibuKey and
click Uninstall.
ForceOverrite=1
Gui=0
ErrorMessages=0
3. At a command prompt from the directory where the dongle-driver installer resides, enter the appropriate
command.
SETUP32.exe /R
SETUP64.exe /R
This chapter describes how to use the FlexNet dongle driver installers for Mac OS X.
Note • Best practice is to install the driver using the user-interface method.
1. Locate the installer file FLEXID9_OSX_V6_65.dmg within your FlexNet Publisher licensing toolkit; or download the
installer from a designated FlexNet Publisher download site. (For example, publishers download from the
Flexera Software Product and License Center: https://flexerasoftware.flexnetoperations.com. End-users should
contact Flexera Software for the appropriate download site.)
2. Double-click the file, and follow the on-screen instructions in the installer to complete the installation.
Note • This procedure is for reference only; it might not work properly on some machines.
After installing manually copy the *.dylib into /usr/lib directories. Refer to Dongle Installers and Shared object.
Note • Best practice is to remove the driver using the user-interface method.
1. Double-click the installer file FLEXID9_OSX_V6_65.dmg. Copy the files from the FLEXID9_OSX_V6_65.dmg to
desktop
sudo ./dunst
sudo ./dinst
1. Enter the following command to list all files installed for the dongle driver:
• Manually delete each of the files that are listed after performing step 1.
Note • This command is for reference only. It might not work properly on some machines.
Note • Best practice is to install the driver using the user-interface method.
1. Locate the installer file FLEXID10_OSX_6.11.500.dmg within your FlexNet Publisher licensing toolkit; or
download the installer from a designated FlexNet Publisher download site. (For example, publishers download
from the Flexera Software Product and License Center: https://flexerasoftware.flexnetoperations.com. End-users
should contact Flexera Software for the appropriate download site.)
2. Double-click the file, and follow the on-screen instructions in the installer to complete the installation.
Note • This procedure is for reference only; it might not work properly on some machines.
Note • Best practice is to remove the driver using the user-interface method.
1. Enter the following commands to list all files installed for the dongle driver:
• Manually delete each of the files that are listed after performing step 1.
Note • This set of commands is for reference only. The commands might not work properly on some
machines.
This chapter describes how to use the FlexNet dongle driver installers for Linux.
• Remove any older versions of the dongle driver. For details, see the next section.
Task: To remove an older version of the FLEXID dongle drive you are installing
At a command prompt from the directory where the dongle-driver installer resides, enter the appropriate command:
rpm –e aksusbd-redhat
rpm –e aksusbd-suse
1. Locate the installer file aksusbd-2.5-1.i386.rpm within your FlexNet Publisher licensing toolkit; or download
the installer from a designated FlexNet Publisher download site. (For example, publishers download from the
Flexera Software Product and License Center: https://flexerasoftware.flexnetoperations.com. End-users should
contact Flexera Software for the appropriate download site.).
2. At a command prompt from the directory where the dongle-driver installer resides, enter the following:
rpm –i aksusbd-2.5-1.i386.rpm
After installing manually copy the *.so into /usr/lib directories. Refer to Dongle Installers and Shared object.
At a command prompt from the directory where the dongle-driver installer resides, enter the following:
rpm -e aksusbd-2.5-1.i386
1. Locate the appropriate installer file within your FlexNet Publisher licensing toolkit; or download the installer
from a designated FlexNet Publisher download site. (For example, publishers download from the Flexera
Software Product and License Center: https://flexerasoftware.flexnetoperations.com. End-users should contact
Flexera Software for the appropriate download site.)
WkRt-Lin-6.11.1057-500.i386.rpm
WkRt-Lin64-6.11.1057-500.x86_64.rpm
2. At a command prompt from the directory where the dongle-driver installer resides, enter the appropriate
command:
rpm –i WkRt-Lin-6.11.1057-500.i386.rpm
rpm –i WkRt-Lin64-6.11.1057-500.x86_64.rpm
Note • The Wibu installers might produce warnings on RedHat EL 4.7 x64, and SUSE9 and SUSE10 x86 platforms,
depending on what operating system patches are installed. Users can ignore these warnings; the dongles operate
correctly.
At a command prompt from the directory where the dongle-driver installer resides, enter the following command:
WkRt-Lin64-6.11.1057-500
The following sections describe how to test that the dongle driver has been installed correctly:
1. Obtaining the Dongle Identity (FLEXID)—Uses the simplest method involving the dongle and lmutil, lmadmin
(on 32-bit platforms), or LMTOOLS required.
• A dongle
This test attempts to obtain the dongle identity from the dongle. The dongle driver is used to access the dongle and
request its identity and thus this tests that the dongle driver has been correctly installed.
1. On Windows systems, if you have just installed the dongle driver, ensure that you restart your system to
complete the installation of the driver software. (Mac and Linux systems do not require a restart.)
• If using lmadmin:
1. Run lmadmin.
2. In a web browser, open the lmadmin user interface. (Default location is http://localhost:8090.)
4. Click Administration.
• If using lmhostid:
Note • The command lmhostid -flexid is to fetch the dongle id and lmhostid -flexid -long command is
used to get the error or log information along with the dongle id.
2. Verify that a valid FLEXID is returned. Example output might be the following:
lmhostid - Copyright <c> 1989-2013 Flexera Software LLC. All Rights Reserved.
The FlexNet host ID of this machine is “FLEXID=9-6b3366b2”
1. Double-click LMTOOLS.exe.
See the Development Environment Guide for more information about toolkit build commands and options.
Task: To issue and use a license that uses a FlexNet ID dongle on an end-user machine
1. Obtain the dongle identity as described in Obtaining the Dongle Identity (FLEXID).
2. Create a license file that contains a license that uses the FLEXID:
• Within your FlexNet Publisher toolkit installation directory, open the example license file <platform_dir>\
uncounted.lic with an editor.
HOSTID=FLEXID=9-6b3366b2
• Sign the license file using lmcrypt. Type the following at a command prompt:
lmcrypt uncounted_FLEXID.lic
• Run lmflex.
Note • The following procedure uses Windows-based command syntax. For UNIX platforms, apply the appropriate
syntax.
Task: To issue and use a license that uses a FlexNet ID dongle on a license server
1. Obtain the dongle identity as described in Obtaining the Dongle Identity (FLEXID).
2. Create a license file that contains a license that uses the FLEXID:
a. Within your FlexNet Publisher toolkit installation directory, open the example license file
<platform_dir>\counted.lic in a text editor.
b. Add the Server line with HOSTID set to the FLEXID, as in the example:
d. Sign the license file using lmcrypt. Type the following at a command prompt:
lmcrypt counted_FLEXID.lic
4. For purposes of this test, copy the vendor daemon demo.exe and its associated library demo_libFNP.dll from
the <platform> directory to the <platform>\lmadmin\demo directory.
Note • On UNIX platforms, copy the vendor daemon demo and its associated library demo_libFNP.so from the
<platform> directory to the <platform>/lmadmin/demo directory. On AIX, copy demo and
demo_server_libFNP_notr.so.
a. Import the license file by entering the following at a command prompt from <platform_dir>\lmadmin:
FAQ
FlexNet ID dongle device drivers are included with the FlexNet Licensing SDKs, which authorized customers may
download from the Product and License Center at the following location:
https://flexerasoftware.flexnetoperations.com
End users of FlexEnabled products that support FlexNet ID dongles must contact their software vendor directly to
download compatible dongle driver version. However, publishers can obtain the latest supported driver versions at
the following location:
http://learn.flexerasoftware.com/content/ECM-Dongle-Drivers
1. Will my 11.11.1 FNP application run seamlessly side-by-side with my FNP 11.12.1 application while using
the same HASP HL dongle?
It works seamlessly. If you face any problem, please refer to troubleshooting scenarios listed below in the
chapter. If you do experience an issue, and the driver version between the FNP versions is different, try
using the older driver.
HASP SRM is used to support multiple dongles on Win64, and is the dongle provider's recommended API
going forward.
We have used dynamic linking of dongle API libraries as the dongle provider's recommended method of
HASP SRM implementation. This needs .dll or .so installation to the system path.
4. Why is only one ‘HASP4’ FLEXID 9 dongle supported? What do I get in exchange for this limitation?
Hasp SRM has limited support to HASP4 keys and they are soon to be End-Of-Life. Before the SRM API was
adopted in FNP 11.12, only one FLEXID9 dongle was supported in Win64. In 11.12, multiple 'HASP HL'
FLEXID9 dongles are now supported on Win64. On Win32, multiple 'HASP HL' dongles are still supported,
but now only one of the older HASP4 dongles is supported. So, by removing support for multiple older
'HASP4' dongles on Win32, Flexera has been able to introduce support for multiple newer 'HASP HL'
dongles on Win64. To reiterate: Multiple 'HASP HL' dongles are supported on both Win32 and Win64 in
FNP 11.12. For more information see Appendix 7, Listed are the possible troubleshooting scenarios:.
The older 'HASP4' revision of the FLEXID9 dongle is shortly to be end-of-life, and may not be supported in
upcoming versions of FNP. Flexera recommends replacing these older dongles with the newer 'HASP HL'
revision.
FLEXID9 Troubleshooting
This troubleshooting information provides guidance to the software publishers and their end-users to troubleshoot
the FLEXID9 dongle related issues that might arise during upgrade of FNP Version 11.12 release on windows
platforms.
FNP 11.12 has changed the FLEXID9 dongle implementation of HASP4 and HASP HL to HASP SRM with the primary
focus on supporting multiple dongle keys and preparing for the next generation of HASP dongles.
HASP4
HASPHL
• Medium ones
Multiple FLEXID 9 dongles will be supported on all platforms from FNP 11.12.1 onwards. Multiple FLEXID 9 dongles
include multiple HASP HL keys and a single HASP4 key.
2. Run the command line installer, haspdinst.exe available in the toolkit (For example:
FLEXID9_Windows_v6_6x_xxx.zip).
3. A README document provided in the toolkit contains a limitation and the action required.
4. The user space dongle dynamic libraries, say haspsrm_win32.dll and haspsrm_win64.dll for 32 and 64 bit
platforms respectively, are not installed when the run-time command-line Installer for sentinel hasp
(haspdinst.exe) is run. This is because these libraries are Flexera specific and therefore not included as part of
the installer. These libraries are present in the toolkit platform folder and publishers should include them in their
own installers when supporting FLEXID9 hostids on Windows. The relevant dll's should be copied to the folder:
• On a 64-bit system, publishers using the x64_n6 kit should install haspsrm_win64.dll to %windir%/
System32.
• On a 64-bit system, publishers using the i86_n3 kit should install haspsrm_win32.dll to %windir%/
SysWOW64.
Important • The new Safenet external license manager (hasp_rt.exe) is now required to be placed in the same folder
of FNP dongle protected applications (including lmhostid, vendor daemon, lmtools and lmadmin). If hasp_rt.exe
doesn’t exists in the same folder, an unexpected Safenet error dialog, referring to the SafeNet 'hasp_cleanup' API may
appears when FLEXID9 Safenet runtime driver wasn’t installed on the machine but the dynamic library
(haspsrm_*.dll) was copied to system32/SysWow64 folder.
• On a 64-bit linux system, publishers using the x64_lsb kit should install libhasp_linux_x86_64.so to /usr/
lib.
• On a 32-bit linux system, publishers using the i86_lsb kit should install libhasp_linux_i686.so to /usr/
lib.
• On a Max OS X system, publishers using the universal_mac kit should install hasp_darwin.dylib to /usr/
lib.
a. If the key type is HASP4, Unplug all the keys. Plug in this HASP4 key, preferably on the first slot of the
primary USB slots. lmhostid utility should list an entry(ID) for this HASP4 key now. Continue plugging in the
rest of the HASP HL keys. If the HASP4 key is still not detected, then, the key could be damaged and
consider replacing the dongle.
b. If the key type is HASP HL, problem could be due to the firmware version of the key. If the firmware version
is less than 3.20, key will not be detected. Upgrade the firmware of your dongle using a utility by Safenet.
Firmware Upgrade utility can be downloaded from this link below and the utility can be used to determine
the firmware version of the key. http://sentinelcustomer.safenet- inc.com/sentineldownloads/
?s=&c=all&p=all&o=all&t=Firmware+Updates&l=all
c. Checkout performance degradation may occur when multiple FLEXID9 keys were present on the machine.
When dongle API is executed, it will communicate to each dongle and perform security check on each of
them. If more dongles were discovered, it will take longer to communicate to each dongle, as a result of
delay occurred. We recommend to limit the number of dongle to a reasonable count on the machine.
In order to support multiple FLEXID9 dongle. Sentinel LDK License Manager must be running on the machine.
Examine the running processes on the machine and look for hasplms (Windows) or hasplmd (Linux and Mac).
On windows, all running processes can be found from Windows Task Manager. On Linux and Mac, the running
processes can be obtained by using “ps –ef” command from command shell. Ensure the latest version of
FLEXID9 dongle runtime driver is installed on the machine. If there is no multiple dongle support after installing
the driver, try to reboot the machine.
3. What If multiple keys were present and some are no longer detected?
Unplug all the FLEXID9 keys. Plugin single key and see if the lmhostid utility lists an entry for the key. This way
you can determine which key is not getting detected. Then, follow the step (1) above, to rectify the problem.
D lmhostid 31
LMTOOLS 31
dongle identity 31
driver installation on Linux
FLEXID10 29
O
FLEXID9 27 operating systems 8
driver installation on Mac
FLEXID10 24
FLEXID9 23
P
driver installation on Windows platforms 8
FLEXID10 19
FLEXID9 17
S
F SETUP32.exe 19
SETUP64.exe 19
FLEXID 7, 31
FLEXID_Dongle_Drvier_Installer.exe 16
FLEXID10_OSX_V6.0.501.dmg 25
FLEXID9_OSX_V6_23.dmg 23
FLEXID9_Windows_V6_51_cmd_line.exe 17
FLEXIDInstaller.exe 16
FlexNet ID dongle
definition 7
hostid 7
platform support 8
H
hostid 7, 33
L
license file 33
lmcrypt 33, 34