UniKey Updater And Generator Tool
UniKey Remote Update
Remote update allows updating a UniKey device's settings without physical access to the device, often after the device has been deployed and no longer in possession of the software developer.
Typically, if settings on a software protection dongle need to be modified or updated, the device must be sent back to the software developer so that settings can be modified directly to the device by developer, then sent back to the client - a process that is costly and time consuming.
UniKey provides the ability to update a UniKey device's settings without access to the device, remotely. UniKey Updater provides a flexible and secure update scheme, where all data in update files (*.upt2) is encrypted by a 128-bit encryption key.
Remote Update Process
There are two steps involved in remotely updating a UniKey device.:
- The Software Vendor generates a UniKey Updater file (*.upt2) with the UniKey Generator, specific for the intended UniKey device.
- The End User receives the UniKey Updater file (*.upt2) sent by the Software Vender, and updates the UniKey device with new settings using UniKey Update.
UniKey Update Generator
The UniKey Update Generator tool is used to creating an update file (*.upt2 file) for remote end-users. It is used to set settings with the UniKey Updater tool, and provides a useful solution for software vendors to remotely update an end-user’s UniKey device.
The Update Generator tool can be found within the UniKey SDK under the directory UniKey SDK\Utilities\Update Tools\Update Generator Tool\.
For UniKey Drive, the Update Generator tool can be found under the directory UniKey Drive SDK\Utilities\Update Tools\Upt2 Generator\.
Basic Settings
In the Generator window, on the "Basic Settings" tab, input the four passwords of the respective UniKey device to be updated.
- Bind HID, Bind SID, Bind Module No., Bind Update Tag: Allows software vendors to generate an update file to operate only on a specified UniKey which matches the set parameters.
- New SID: Allows a software vendor to set a new software ID for the UniKey device.
- New Update Tag: Allows a software vendor to set a new Update Tag. The Update Tag is solely for the purpose of distinguishing between .upt2 update files.
Memory Settings
Clicking [Add] will open the "Add Memory" window, as shown below.
In the "Add Memory" window, the data field displays the data that will overwrite the contents of the target UniKey device's memory, beginning from position [Start Address] of the input data's [Length]. Data can be loaded in through [Load], loading the hexidecimal values of the file, and saved through [Save].
Memory records can be later edited or deleted from the "Memory Settings" tab.
Module Settings
"Module Settings" enables you to set your software module no. and module value to your update file.
Clicking [Add] will open the "Add Module" window, as shown below.
In the "Add Module" window, input the module number, between 0 and 63 inclusive, and value, between 0 and 65535 inclusive to add a new module. Checking the [Autodecrement] option will automatically decrement the module's value by default.
Modules can be later edited or deleted from the "Module Settings" tab.
Arithmetic Settings
Clicking [Add] will open the "Add Algorithm" window, as shown below.
To add a new algorithm in the "Add Algorithm" window, input the start address of the algorithm under [Start Point] (0-127) and the algorithm. The entered algorithm must entered be in the format "A=B+C". To add more than one algorithm, use a comma (,) to separate algorithms. Input that has incorrect syntax will return the error "Invalid algorithm format". Variables can be defined by the end user.
Algorithms can be later edited or deleted from the "Arithmetic Settings" tab.
Time Settings (UniKey Time only)
Time modules can be set through the "Time Settings" tab, with each time module indicating the exact Start Time and End Time or Duration of each corresponding Module No. (0-15). Selecting the "End Time" option, whereby the module is set to expire once the entered date has been reached, the expiry date is entered in the format (YY-MM-DD:HH), whereas selecting the "Duration" option, whereby the module is set to expire after the entered time has lapsed, the time duration must be entered in the format (DD:HH).
Clicking [Add] will open the "Add Time Modules" window, as shown below.
To add a new time module in the "Add Time Modules" window, input the Module No, the Start Time (the time at which the module is enabled) in the format (YY-MM-DD:HH), then either the "End Time" or "Duration" in the correct format of the module.
Time modules can be later edited or deleted from the "Time Settings" tab.
UPT File
After settings have been configured, the .upt2 file containing the setting for the UniKey device to be updates can be generated through the "UPT File" tab.
In the "UPT File" tab, a password can be set for the generated .upt2 file, which must be entered by the end user in the Updater Tool to update the device. To protect the generated .upt2 file with a password, tick the [Set File Password] box and enter the password twice in [UPT File Password] and [Verify Password] fields.
To generate the .upt2 files, click [Generate]. A save file window will pop up, as shown below, to save the generated file in a chosen directory.
The below message will appear if successful.
Remote Updater
Once the UniKey Update file (*.upt2) has been recieved by the end user, following the below steps will update the UniKey device:
- With the corresponding UniKey device plugged in, open the Updater tool located at
UniKey SDK\Utilities\Update Tools\Updater Tool\For Windows\Updater.exe.
Note: For UniKey Drive, the Updater tool can be located at UniKey Drive SDK\Utilities\Update Tools\Updater\Updater.exe.
- In the Updater tool, open the .upt2 file. If a password is required, input the password.
- Click [Update].
Once successful, the UniKey device has been updated with the .upt2's settings.
