TABLE OF CONTENTS
- Managing Security Devices and Licenses
Managing Security Devices and Licenses
This appendix includes information Exterro product licenses, Virtual CodeMeter activation, Network License Server, and API Key configurations.
Installing and Managing Security Devices
Exterro products require a licensing security device that communicates with the program to verify the existence of a current license.
You must install the security device software and drivers before you can manage licenses with License Manager.
This section explains installing and using the CodeMeter Runtime software and the License Manager.
Installing the Security Device
Exterro products require a licensing security device that communicates with the program to verify the existence of a current license. The device is a WIBU-SYSTEMS (Wibu) CodeMeter (CmStick). This USB device requires specific software to be installed prior to connecting the devices and running your Exterro products.
You will need the WIBU-SYSTEMS CodeMeter Runtime software with a WIBU-SYSTEMS CodeMeter (CmStick), either the physical USB device, or the Virtual device.
Store the CmStick or dongle in a secure location when it is not in use.
Installing the CodeMeter Runtime Software
When you purchase a product, Exterro provides a USB CmStick with the product package. To use the CmStick, you must first install the CodeMeter Runtime software, either from the shipping disc or from the setup file downloaded from the Exterro website.
Note: The CodeMeter software is automatically installed as part of the FTK suite.
To download the CodeMeter installer from the Exterro website:
- Go to the Exterro download page at: http://www.Exterro.com/product-download.
- On the download page, click CodeMeter.
- Click Download Page.
- Click Download Now.
- Save the installation file to your download directory or other temporary directory on your drive.
To install CodeMeter:
- Launch the installer from the download by doing the following:
- Navigate to the CodeMeter installation folder (“\{F5F91CCC-5315-49F7-8849-AE1673C65222}”), and double-click the installation file.
- Wait for the Preparing to Install processes to complete.
- In the Welcome dialog, click Next.
- Read and accept the License Agreement
- Enter User Information.
- Click Next.
- Select the features you want to install.
- Click Next > Install > Finish.
- Click OK.
CodeMeter Error
If you are not using NLS for your security device configuration, after clicking No, you will see the following additional message.
- Security Device Not Found
To remedy, click OK, then install the correct CodeMeter Runtime software, and connect the CmStick or run License Manager to generate your Virtual CmStick. Then, restart FTK.
Installing License Manager
License Manager lets you manage product and license subscriptions using a security device or device packet file.
You can access the License Manager installer from the Web or from the FTK installer.
To download the License Manager installer from the Exterro website:
- Go to the Exterro download page at: http://www.Exterro.com/product-download.
- On the download page, click License Manager.
- Click Download Page.
- Click Download Now.
- Save the installation file to your download directory or other temporary directory on your drive.
To install License Manager:
- Navigate to the License Manager installation folder (“\{6F8C49D6-8EDC-4F06-9348-2E6EC0798963}”), and double-click the installation file.
- Wait for the Preparing to Install processes to complete.
- Click Next on the Welcome screen
- Read and accept the License Agreement.
- Click Next.
- Accept the default destination folder, or select a different one.
- Click Next.
- In the Ready to Install the Program dialog, click Back to review or change any of the installation settings. When you are ready to continue, click Install.
- Wait while the installation completes.
- If you want to launch License Manager after completing the installation, mark the Launch AccessData License Manager check box.
- Select the Launch AccessData License Manager check box to run the program upon finishing the setup. The next section describes how to run License Manager later.
- Click Finish to finalize the installation and close the wizard.
Starting License Manager
To launch License Manager:
Launch License Manager by clicking the License Manager icon on your desktop.
When starting, License Manager reads licensing and subscription information from the installed and connected WIBU-SYSTEMS CodeMeter Stick, or Keylok dongle.
Note: If using a Keylok dongle, and License Manager either does not open or displays the message, “Device Not Found”
- Verify the correct dongle driver is installed on your computer.
- With the dongle connected, check in Windows Device Manager to make sure the device is recognized. If it has an error indicator, right click on the device and choose Uninstall.
- Remove the dongle after the device has been uninstalled.
- Reboot your computer.
- After the reboot is complete, and all startup processes have finished running, connect the dongle.
- Wait for Windows to run the Add New Hardware wizard. If you already have the right dongle drivers installed, do not browse the internet, choose, “No, not this time.”
- Click Next to continue.
- On the next options screen, choose, “Install the software automatically (Recommended)
- Click Next to continue.
- When the installation of the dongle device is complete, click Finish to close the wizard.
- You still need the CodeMeter software installed, but will not need a CodeMeter Stick to run License Manager.
Note: If using a CodeMeter Stick, and License Manager either does not open or displays the message, “Device Not Found”.
12. Make sure the CodeMeter Runtime 4.20b software is installed. It is available at www.Exterro.com/support.
- Click Downloads and browse to the product.
- Click on the download link. You can Run the product from the Website, or Save the file locally and run it from your PC.
- Once the CodeMeter Runtime software is installed and running, you will see a gray icon in your system tray.
13. Make sure the CodeMeter Stick is connected to the USB port.
If the CodeMeter Stick is not connected, License Manager still lets you to manage licenses using a security device packet file if you have exported and saved the file previously.
To open License Manager without a CodeMeter Stick installed:
- Click Tools > License Manager.
License Manager displays the message, “Device not Found”.
2. Click OK, then browse for a security device packet file to open.
Note: Although you can run License Manager using a packet file, Exterro products will not run with a packet file alone. You must have the CmStick or dongle connected to the computer to run Exterro products that require a license.
Using License Manager
License Manager provides the tools necessary for managing Exterro product licenses on a WIBU-
SYSTEMS CodeMeter Stick security device, a Keylok dongle, a Virtual Dongle, or in a security device packet file.
License Manager displays license information, allows you to add licenses to or remove existing licenses from a dongle or CmStick. License Manager, and can also be used to export a security device packet file. Packet files can be saved and reloaded into License Manager, or sent via email to Exterro support.
In addition, you can use License Manager to check for product updates and in some cases download the latest product versions.
License Manager displays CodeMeter Stick information (including packet version and serial number) and licensing information for all Exterro products. The Purchase Licenses button connects directly to the Exterro website and allows you to browse the site for information about products you may wish to purchase. Contact Exterro by phone to speak with a Sales Representative for answers to product questions, and to purchase products and renew licenses and subscriptions.
The License Manager Interface
The License Manager interface consists of the following two tabs that organize the options in the License Manager window
- Installed Components
- Licenses
Installed Components Tab
The Installed Components tab lists the Exterro programs installed on the machine. The Installed Components tab is displayed in the following figure.
The following information is displayed on the Installed Components tab:
- License Manager Installed Components Tab Features
Item | Description |
---|---|
Program | Lists all Exterro products installed on the host. |
Installed Version | Displays the version of each Exterro product installed on the host. |
Newest Version | Displays the latest version available of each Exterro product installed on the host. Click Newest to refresh this list. |
Product Notes | Displays notes and information about the product selected in the program list. |
Exterro Link | Links to the Exterro product page where you can learn more about Exterro products. |
The following buttons provide additional functionality from the Installed Components tab:
- License Manager Installed Components Buttons
Button | Function |
---|---|
Help | Opens the License Manager Help web page. |
- License Manager Installed Components Buttons (Continued)
Button | Function |
---|---|
Install Newest | Installs the newest version of the programs checked in the product window, if that program is available for download. You can also get the latest versions from our website using your Internet browser. |
Newest | Updates the latest version information for your installed products. |
About | Displays the About License Manager screen. Provides version, copyright, and trademark information for License Manager. |
Done | Closes License Manager. |
Use the Installed Components tab to manage your Exterro products and stay up to date on new releases.
Licenses Tab
The Licenses tab displays CodeMeter Stick information for the current security device packet file and licensing information for Exterro products available to the owner of the CodeMeter Stick, as displayed in the following figure.
The Licenses tab provides the following information:
License Manager Licenses Tab Features:
Column | Description |
---|---|
Program | Shows the owned licenses for Exterro products. |
Expiration Date | Shows the date on which your current license expires. |
Status | Shows this status of that product’s license: None: the product license is not currently owned Days Left: displays when less than 31 days remain on the license. Never: the license is permanently owned. This generally applies to Hash Tables and Portable Office Rainbow Tables. |
Name | Shows the name of additional parameters or information a product requires for its license. |
Value | Shows the values of additional parameters or information a product contained in or required for its license. |
Show Unlicensed | When checked, the License window displays all products, whether licensed or not. |
License Management Options:
The following license management actions can be performed using buttons found on the License tab:
Button | Function |
---|---|
Remove License | Removes a selected license from the Licenses window and from the CodeMeter Stick or dongle. Opens the Exterro License Server web page to confirm success. |
Refresh Device | Connects to the Exterro License Server. Downloads and overwrites the info on the CodeMeter Stick or dongle with the latest information on the server. |
Reload from Device | Begins or restarts the service to read the licenses stored on the CodeMeter Stick or dongle. |
Release Device | Click to stop the program reading the dongle attached to your machine, much like Windows’ Safely Remove Hardware feature. Click this button before removing a dongle. This option is disabled for the CodeMeter Stick. |
Open Packet File | Opens Windows Explorer, allowing you to navigate to a .PKT file containing your license information. |
Save to File | Opens Windows Explorer, allowing you to save a .PKT file containing your license information. The default location is My Documents. |
Finalize Removal | Finishes the removal of licenses in the unbound state. Licenses must be unbound from the CmStick or dongle before this button takes effect. |
View Registration Info | Displays an HTML page with your CodeMeter Stick number and other license information. |
Add Existing License | Allows you to bind an existing unbound license to your CodeMeter Stick, through an internet connection to the Exterro License Server. |
Purchase License | Brings up the Exterro product page from which you can learn more about Exterro products. |
About | Displays the About License Manager screen. Provides version, copyright, and trademark information for License Manager. |
Done | Closes License Manager. |
Opening and Saving Dongle Packet Files
You can open or save dongle packet files using License Manager. When started, License Manager attempts to read licensing and subscription information from the dongle. If you do not have a dongle installed, License Manager lets you browse to open a dongle packet file. You must have already created and saved a dongle packet file to be able to browse to and open it.
To save a security device packet file:
- Click the Licenses tab, then under License Packets, click Save to File.
- Browse to the desired folder and accept the default name of the .PKT file; then click Save.
To open a security device packet file:
- Select the Licenses tab.
- Under License Packets, click Open Packet File.
- Browse for a dongle packet file to open. Select the file and click Open.
Adding and Removing Product Licenses
On a computer with an Internet connection, License Manager lets you add available product licenses to, or remove them from, a dongle.
To move a product license from one dongle to another dongle, first remove the product license from the first dongle. You must release that dongle, and connect the second dongle before continuing. When the second dongle is connected and recognized by Windows and License Manager, click on the Licenses tab to add the product license to the second dongle.
Removing a License
To remove (unassociate or unbind) a product license:
- From the Licenses tab, mark the program license to remove.
- This action activates the Remove License button below the Program list box.
- Click Remove License to connect your machine to the Exterro License Server through the internet.
- When you are prompted to confirm the removal of the selected licenses from the device, click Yes to continue, or No to cancel.
- Several screens appear indicating the connection and activity on the License Server, and when the license removal is complete, the following screen appears.
- Click OK to close the message box.
Note: Another internet browser screen appears from License Manager with a message that says, “The removal of your licenses from Security Device was successful!” You may close this box at any time.
Adding a License
To add a new or released license:
- From the Licenses tab, under Browser Options, click Add AccessData License.
- The AccessData License Manager Web page opens, listing the licenses currently bound to the connected security device, and below that list, you will see the licenses that currently are not bound to any security device. Mark the box in the Bind column for the product you wish to add to the connected device, then click Submit.
- An AccessData License Manager Web page will open, displaying the following message, “The Exterro products that you selected has been bound to the record for Security Device <ID number> within the Security Device Database.
- “Please run License Manager’s “Refresh Device” feature in order to complete the process of binding these product licenses to this Security Device.” You may close this window at any time.
- Click Yes if License Manager prompts, “Were you able to associate a new product with this device?”
- Click Refresh Device in the Licenses tab of License Manager. Click Yes when prompted.
You will see the newly added license in the License Options list.
Adding and Removing Product Licenses Remotely
While License Manager requires an Internet connection to use some features, you can add or remove licenses from a dongle packet file for a dongle that resides on a computer, such as a forensic lab computer, that does not have an Internet connection.
If you cannot connect to the Internet, the easiest way to move licenses from one dongle to another is to physically move the dongle to a computer with an Internet connection, add or remove product licenses as necessary using License Manager, and then physically move the dongle back to the original computer. However, if you cannot move the dongle—due to organization policies or a need for forensic soundness—then transfer the packet files and update files remotely.
Adding a License Remotely
To remotely add (associate or bind) a product license:
- On the computer where the security device resides:
- Run License Manager.
- From the Licenses tab, click Reload from Device to read the dongle license information.
- Click Save to File to save the dongle packet file to the local machine.
2. Copy the dongle packet file to a computer with an Internet connection.
3. On the computer with an Internet connection:
- Remove any attached security device.
- Launch License Manager. You will see a notification, “No security device found”.
- Click OK.
- An “Open” dialog box will display. Highlight the .PKT file, and click Open.
- Click on the Licenses tab.
- Click Add Existing License.
- Complete the process to add a product license on the Website page.
- Click Yes when the License Manager prompts, “Were you able to associate a new product with this dongle?”
- When License Manager does not detect a dongle or the serial number of the dongle does not match the serial number in the dongle packet file, you are prompted to save the update file, [serial#].wibuCmRaU.
- Save the update file to the local machine.
4. After the update file is downloaded, copy the update file to the computer where the dongle resides:
5. On the computer where the dongle resides:
- Run the update file by double-clicking it. ([serial#].wibuCmRaU is an executable file.)
- After an update file downloads and installs, click OK.
- Run License Manager.
- From the Licenses tab, click Reload from Device to verify the product license has been added to the dongle.
Removing a License Remotely
To remotely remove (unassociated, or unbind) a product license:
- On the computer where the dongle resides:
- Run License Manager.
- From the Licenses tab, click Reload from Device to read the dongle license information.
- Click Save to File to save the dongle packet file to the local machine.
2. Copy the file to a computer with an Internet connection.
3. On the computer with an Internet connection:
- Launch License Manager. You will see a notification, “No security device found”.
- Click OK.
- An “Open” dialog box will display. Highlight the .PKT file, and click Open.
- Click on the Licenses tab.
- Mark the box for the product license you want to unassociate; then click Remove License.
- When prompted to confirm the removal of the selected license from the dongle, click Yes.
- When License Manager does not detect a dongle or the serial number of the dongle does not match the serial number in the dongle packet file, you are prompted save the update file.
- Click Yes to save the update file to the local computer.
- The Step 1 of 2 dialog details how to use the dongle packet file to remove the license from a dongle on another computer.
- Save the update file to the local machine.
4. After the update file is downloaded, copy the update file to the computer where the dongle resides.
5. On the computer where the dongle resides:
- Run the update file by double-clicking it. This runs the executable update file and copies the new information to the security device.
- Run License Manager
- On the Licenses tab, click Reload from Device in License Manager to read the security device and allow you to verify the product license is removed from the dongle.
- Click Save to File to save the updated dongle packet file to the local machine.
6. Copy the file to a computer with an Internet connection.
Sending a Dongle Packet File to Support
Send a security device packet file only when specifically directed to do so by Exterro support.
To create a dongle packet file:
- Run License Manager
- Click on the Licenses tab.
- Click Load from Device.
- Click Refresh Device if you need to get the latest info from AD’s license server.
- Click Save to File, and note or specify the location for the saved file.
- Attach the dongle packet file to an e-mail and send it to support@exterro.com
Virtual CodeMeter Activation Guide
Introduction
A Virtual CodeMeter (VCM) allows the user to run licensed Exterro products without a physical CodeMeter device. A VCM can be created using AccessData License Manager, but requires the user to enter a Confirmation Code during the creation process.
Preparation
- Contact your Exterro sales rep to order a VCM confirmation code.
- Install the CodeMeter Runtime 7.30 or newer verision. (available on the Wibu download page)
- Install the latest release of License Manager (available on the Exterro download page).
- The following steps are to be run on the system where you want to permanently attach the VCM.
Note: Once created, the VCM cannot be moved to any other system.
Setup for Online Systems
To setup a virtual CodeMeter:
- Unplug any Exterro dongles you currently have connected.
- Launch License Manager.
- Select Create A Local Virtual CMStick.
- Click OK.
- In the Confirmation Code Required dialog, enter your confirmation code.
- Click OK.
AccessData License Manager will automatically synchronize with the License Server over the Internet.
7. Click OK when the update completes.
Upon performing the above step, License Manager will create the VCM on the system. Once all the steps are performed, AccessData License Manager displays a serial number for the VCM on the Licenses tab and the VCM can now operate in a similar way to a hardware CodeMeter device.
Setting up VCM for Offline Systems
You can setup a Virtual CodeMeter on a system that is not connected to the internet (offline). You must also have one machine that connects to the internet to perform certain steps. This section details what to do on which machine.
To perform these steps on the online system:
- Unplug any Exterro dongles you currently have connected.
- Launch License Manager.
- Select Create Empty Virtual CMStick (offline).
- Click OK.
- The resulting dialog prompts you to save the *.wibucmrau file. Enter a name and path for the file, then click Save.
- Transfer the *.wibucmrau to the Online system.
To perform these steps on the online system:
- Unplug any Exterro dongles you currently have connected.
- Launch License Manager.
- Select Create Activation File (online).
- Click OK.
- In the Confirmation Code Required dialog, enter your confirmation code and click OK.
AccessData License Manager will automatically synchronize with the License Server over the internet.
6. Data synchronized from the server will be written to the *.wibucmrau file. Click OK when the update completes.
7. Transfer *.wibucmrau back to the offline system.
To perform these steps on the offline system:
- Unplug any Exterro dongles you currently have connected.
- Launch License Manager.
- Select Create Activate Virtual CMStick (offline).
- Click OK.
- The resulting dialog prompts you to browse to the location of the newly updated *.wibucmrau file. Locate the file, then click Open. License Manager creates the VCM on your system.
- At this point, AccessData License Manager should now display a serial number for the VCM on the “Licenses” tab and the VCM can now operate in a similar way to a hardware CodeMeter device.
Virtual CodeMeter FAQs
Q: How do I get a Virtual CodeMeter (VCM)?
A: Contact your Exterro product sales representative. They will provide you with a VCM confirmation code.
Q: How do VCMs work?
A: A VCM operates in almost exactly the same way as a hardware CodeMeter device, except that they exist as a file stored on the hard disk. During activation, the VCM file (named with a WBB extension) is tied to the hardware of the system using unique hardware identifiers. Those unique identifiers make VCMs non-portable. When AccessData License Manager is launched, it will automatically load the VCM and display its license information. From there, you can refresh, remove, add existing licenses, etc just the same you would with a hardware security device.
Q: Are VCMs supported on virtual machines (VM)?
A: No. Due to the fact that virtual machines are portable and VCMs are not, VCMs are not supported on virtual machines. Currently it is recommended to use Exterro Network License Service (NLS) to license systems running as virtual machines.
Q: How can I “unplug” a VCM?
A: If you want to prevent License Manager from automatically loading the VCM you can "unplug" it by stopping the CodeMeter Runtime Service server and then moving (cut and paste) the WBB file to a new location (renaming the file does not suffice). By default the WBB file is located at:
32 bit systems:
C:\Program Files\CodeMeter\CmAct\
64 bit systems:
C:\Program Files (x86)\CodeMeter\CmAct\
Q: I have activated a VCM on my system, but now I need to activate it on a different system. What should I do?
A: Since a VCM is uniquely tied to the system on which it is activated, it cannot be moved to any other system. If you need to activate a VCM on a different system, you need to contact your Exterro Sales Representative.
Q: What if I need to reinstall Windows, format my drive, change my system's hardware, or back up my VCM in case of a disaster? Will the VCM still work?
A: The VCM can be backed up by simply copying the WBB file to a safe location. It can be restored by copying the WBB file to the CmAct folder. The VCM cannot be restored without a WBB file. If you do not have a backup of your WBB file, you will need to get a new confirmation code from your Exterro Sales Representative.
About API Key Generation
To generate an API authentication key, your CodeMeter License dongle must have the ADAPI sub-license (with current expiration date) applied as a license attribute of your AD FTK / Lab / Enterprise license. As long as this dongle is plugged into the machine when you launch the FTK.exe program, you will be able to generate API keys through the application. Typically, you will want to bind this key to the application administrator account so that the API key has access to all of the REST API calls.
How to generate an API key:
- Insert the CodeMeter licensed for ADAPI to the Examiner system.
- Launch FTK/Lab/Enterprise/QView
Note: QView requires users to obtain an API key using the Administration tab.
3. In the Case Management interface, select the Access API Key option from the Tools menu.
4. In the Access API Key Manager window, select the user account for whom you wish to generate an API key.
Note: Appropriate API related permissions will be granted to the selected user account once the API key is generated.
5. Click the Generate Key button.
6. The generated API key will populate in the key field.
To generate API key via FTK Central:
- Navigate to FTK Central.
- Follow the notation below, to access your API key.
<FTKCentralURL>/api/security/{userid}/getenterpriseapiguid
Note: Appropriate API related permissions will be granted to the selected user account once the API key is generated.