UniKey Updater And Generator Tool: Difference between revisions

From SecuTech Wiki
Jump to navigationJump to search
← Older editNewer edit →

Bao (talk | contribs)

0 edits
Bao (talk | contribs)
0 edits
Bao (talk | contribs)
0 edits
Updated page to newest version, including images, added to manuals category
Line 1: Line 1:
[[category:UniKey Application Solutions]]
[[category:UniKey Tools]]
[[category:UniKey Manuals]]
==<b>UniKey Updater &amp; Generator</b>==


== UniKey Remote Update ==
<b><i>Version 8.3</i></b>


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.
<table class="wikitable">
<tr>
  <td style="background-color: red;"><b style="color: #fff;">Version</b></td>
  <td style="background-color: red;"><b style="color: #fff;">Date</b></td>
</tr>
<tr>
  <td>1.0</td>
  <td>2006.1</td>
</tr>
<tr>
  <td>1.1</td>
  <td>2006.8</td>
</tr>
<tr>
  <td>1.2</td>
  <td>2006.10</td>
</tr>
<tr>
  <td>1.3</td>
  <td>2006.12</td>
</tr>
<tr>
  <td>2.0</td>
  <td>2007.2</td>
</tr>
<tr>
  <td>2.1</td>
  <td>2007.4</td>
</tr>
<tr>
  <td>2.2</td>
  <td>2007.8</td>
</tr>
<tr>
  <td>3.0</td>
  <td>2008.5</td>
</tr>
<tr>
  <td>4.0</td>
  <td>2008.8</td>
</tr>
<tr>
  <td>5.0</td>
  <td>2009.3</td>
</tr>
<tr>
  <td>6.0</td>
  <td>2010.4</td>
</tr>
<tr>
  <td>7.0</td>
  <td>2010.6</td>
</tr>
<tr>
  <td>7.1</td>
  <td>2010.8</td>
</tr>
<tr>
  <td>7.3</td>
  <td>2010.9</td>
</tr>
<tr>
  <td>8.0</td>
  <td>2012.3</td>
</tr>
<tr>
  <td>8.1</td>
  <td>2012.4</td>
</tr>
<tr>
  <td>8.2</td>
  <td>2016.5</td>
</tr>
<tr>
  <td>8.3</td>
  <td>2016.7</td>
</tr>
</table>


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.
==Remote Updater==


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.
[[File:updater select file.png|300px]]


=== Remote Update Process ===
===General Information about the Remote Updater===
It is a common need for software vendors to upgrade their software at the end-user side. UniKey provides a remote update solution so that the end-user does not need to send the UniKey dongle back to the software vendor. By using UniKey Remote Updater, all updating can be done by simply clicking the mouse.  UniKey Remote Updater is secure. All the data is encrypted and protected by a 128-bit key.  UniKey Remote Updater provides a flexible updating scheme. By implementing updating criteria, software vendors can update a single UniKey dongle, a batch of UniKey dongles, or specific UniKeys with the correct SID. Software vendors can also set a pass phrase to the UniKey Updater files (*.upt). So that only end-users with the correct password can use the file to update a UniKey dongle.


There are two steps involved in remotely updating a UniKey device.:
===How to Update a UniKey Dongle Remotely===
There are 2 steps to update a UniKey dongle remotely:
# The Software vendor generates a UniKey Updater file with the UniKey Generator.
# The end-user receives this .upt file and uses the UniKey Updater tool to apply new settings to the UniKey.


# The Software Vendor generates a UniKey Updater file (*.upt2) with the UniKey Generator, specific for the intended UniKey device.
[[File:unikey updater diagram.jpeg|600px]]
# 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.


[[Image:UniKey_RemoteUpdate_Tool_Pic14.jpg]]
==UniKey Generator==
UniKey Generator is used when creating an update file (*.upt file) for remote end-users. It works with the UniKey Updater, to provide a practical and reliable solution for software vendors to remotely update an end-users UniKey.


== UniKey Update Generator ==
===Basic Settings===
In the generator window, on the Basic Settings tab, enter the UniKeys four passwords respectively.


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.
[[File:generator basic settings.png|thumb|left|500px|The default passwords are only 1234]]


The Update Generator tool can be found within the UniKey SDK under the directory <code>UniKey SDK\Utilities\Update Tools\Update Generator Tool\</code>.
<div style="clear:both;"></div>
* New SID: Allows a software vendor to set a new software ID for the UniKey.
* New Update Tag: Allows a software vendor to set a new update tag.
* <b>Bind HID</b>, <b>Bind SID</b>, <b>Bind Module No. </b>and <b>Bind Update Tag</b>: Allows software vendors to generate an update file to operate only on a specified UniKey which matches the set parameters.


For UniKey Drive, the Update Generator tool can be found under the directory <code>UniKey Drive SDK\Utilities\Update Tools\Upt2 Generator\</code>.
===Memory Settings===


=== Basic Settings ===
[[File:generator memory settings.png|500px]]


In the Generator window, on the "Basic Settings" tab, input the four passwords of the respective UniKey device to be updated.
When you click Add, an Add Memory window will pop up as below.


[[Image:UniKey_RemoteUpdate_Tool_Pic01.jpg]]
[[File:generator add memory.png|300px]]


* 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.
Click Load to open a file, and the files content will be displayed in the data message box. Click Save to save the file. Enter the start address and length to open part of the files content. Click OK to add this file to Memory Settings. The files content that is added will be displayed in the Memory Settings message box. Users can edit this data by picking each file in the list, and can also delete files.
* 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. <!--Check-->


=== Memory Settings ===
===Module Settings===
Module Settings enables you to set your software module number and module value to your update file.


[[Image:UniKey_RemoteUpdate_Tool_Pic02.jpg]]
[[File:generator module settings.png|500px]]


Clicking [Add] will open the "Add Memory" window, as shown below.
Clicking on Add will bring up an Add Module window. Enter the module number and value, using the Auto-decrement option will decrement the module value for automatically.


[[Image:UniKey_RemoteUpdate_Tool_Pic03.jpg]]
[[File:generator add module.png|300px]]


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].
Click OK to confirm your settings. All setting parameters will be listed in the message box and you can then edit or delete selected settings at will.


Memory records can be later edited or deleted from the "Memory Settings" tab.
===Arithmetic Settings===


=== Module Settings ===
[[File:generator arithmetic settings.png|500px]]


"Module Settings" enables you to set your software module no. and module value to your update file.
Click Add to add a new algorithm.


[[Image:UniKey_RemoteUpdate_Tool_Pic04.jpg]]
[[File:generator add algorithms.png|300px]]


Clicking [Add] will open the "Add Module" window, as shown below.
Enter a starting point value for the algorithm. The format of the algorithm must be written as A=B+C (no spaces) and variables can be defined by the customer. To add more than one algorithm use a comma (,) to separate algorithms. Click OK to add your new Algorithm. All your settings will be listed in the Arithmetic Settings message box. Click Edit to change your settings, and click Delete to remove.


[[Image:UniKey_RemoteUpdate_Tool_Pic05.jpg]]
===Time Settings (Only for UniKey Time)===


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.<!--Check-->
[[File:generator time settings.png|500px]]


Modules can be later edited or deleted from the "Module Settings" tab.
Time Settings can only be used by the UniKey Time, indicating the exact start, end, or duration of each corresponding Module No. (0-15), this is designed to enable software renting or leasing. By setting parameters in this section, software vendors can set up a software module number and its corresponding start time (YY-MM-DD:HH), end time (YY-MM-DD:HH) or duration time (DD:HH). Click Add to add another module, select an item then click Edit to change your settings, or click Delete to remove the selected setting. When you click on Add, an Add Time Modules window will pop up.


=== Arithmetic Settings ===
[[File:generator add time module.png|300px]]


[[Image:UniKey_RemoteUpdate_Tool_Pic06.jpg]]
Enter the module number and start time. Either the end time or duration must be entered to add a Time Module. Click ok to add this module. Your settings will be displayed in the message box.


Clicking [Add] will open the "Add Algorithm" window, as shown below.
===UPT File===
In the UPT File tab, if you want to generate a password for this update file, please enable the Set File Password check box and input your desired password.


[[Image:UniKey_RemoteUpdate_Tool_Pic07.jpg]]
[[File:generator upt file.png|500px]]


<!--Check, add more useful information for the algorithm syntax and example etc.-->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.
Click Generate. A save file window will pop up as below, and you can set the directory to save in and a name for the update file.


Algorithms can be later edited or deleted from the "Arithmetic Settings" tab.
[[File:generate save file.PNG|500px]]


=== Time Settings (UniKey Time only) ===
Congratulations! You have generated the Update file if you see the window below.


[[Image:UniKey_RemoteUpdate_Tool_Pic08.jpg]]
[[File:upt file success.png|300px]]
 
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.
 
[[Image:UniKey_RemoteUpdate_Tool_Pic09.jpg]]
 
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.
 
[[Image:UniKey_RemoteUpdate_Tool_Pic10.jpg]]
 
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.
 
[[Image:UniKey_RemoteUpdate_Tool_Pic11.jpg]]
 
The below message will appear if successful.
 
[[Image:UniKey_RemoteUpdate_Tool_Pic12.jpg]]
 
== Remote Updater ==
 
[[Image:UniKey_RemoteUpdate_Tool_Pic13.jpg]]
 
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 <code>UniKey SDK\Utilities\Update Tools\Updater Tool\For Windows\Updater.exe</code>.
''Note: For UniKey Drive, the Updater tool can be located at <code>UniKey Drive SDK\Utilities\Update Tools\Updater\Updater.exe</code>.''
# 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.

Revision as of 13:51, 27 July 2016

UniKey Updater & Generator

Version 8.3

Version Date
1.0 2006.1
1.1 2006.8
1.2 2006.10
1.3 2006.12
2.0 2007.2
2.1 2007.4
2.2 2007.8
3.0 2008.5
4.0 2008.8
5.0 2009.3
6.0 2010.4
7.0 2010.6
7.1 2010.8
7.3 2010.9
8.0 2012.3
8.1 2012.4
8.2 2016.5
8.3 2016.7

Remote Updater

General Information about the Remote Updater

It is a common need for software vendors to upgrade their software at the end-user side. UniKey provides a remote update solution so that the end-user does not need to send the UniKey dongle back to the software vendor. By using UniKey Remote Updater, all updating can be done by simply clicking the mouse. UniKey Remote Updater is secure. All the data is encrypted and protected by a 128-bit key. UniKey Remote Updater provides a flexible updating scheme. By implementing updating criteria, software vendors can update a single UniKey dongle, a batch of UniKey dongles, or specific UniKeys with the correct SID. Software vendors can also set a pass phrase to the UniKey Updater files (*.upt). So that only end-users with the correct password can use the file to update a UniKey dongle.

How to Update a UniKey Dongle Remotely

There are 2 steps to update a UniKey dongle remotely:

  1. The Software vendor generates a UniKey Updater file with the UniKey Generator.
  2. The end-user receives this .upt file and uses the UniKey Updater tool to apply new settings to the UniKey.

UniKey Generator

UniKey Generator is used when creating an update file (*.upt file) for remote end-users. It works with the UniKey Updater, to provide a practical and reliable solution for software vendors to remotely update an end-users UniKey.

Basic Settings

In the generator window, on the Basic Settings tab, enter the UniKeys four passwords respectively.

The default passwords are only 1234
  • New SID: Allows a software vendor to set a new software ID for the UniKey.
  • New Update Tag: Allows a software vendor to set a new update tag.
  • Bind HID, Bind SID, Bind Module No. and Bind Update Tag: Allows software vendors to generate an update file to operate only on a specified UniKey which matches the set parameters.

Memory Settings

When you click Add, an Add Memory window will pop up as below.

Click Load to open a file, and the files content will be displayed in the data message box. Click Save to save the file. Enter the start address and length to open part of the files content. Click OK to add this file to Memory Settings. The files content that is added will be displayed in the Memory Settings message box. Users can edit this data by picking each file in the list, and can also delete files.

Module Settings

Module Settings enables you to set your software module number and module value to your update file.

Clicking on Add will bring up an Add Module window. Enter the module number and value, using the Auto-decrement option will decrement the module value for automatically.

Click OK to confirm your settings. All setting parameters will be listed in the message box and you can then edit or delete selected settings at will.

Arithmetic Settings

Click Add to add a new algorithm.

Enter a starting point value for the algorithm. The format of the algorithm must be written as A=B+C (no spaces) and variables can be defined by the customer. To add more than one algorithm use a comma (,) to separate algorithms. Click OK to add your new Algorithm. All your settings will be listed in the Arithmetic Settings message box. Click Edit to change your settings, and click Delete to remove.

Time Settings (Only for UniKey Time)

Time Settings can only be used by the UniKey Time, indicating the exact start, end, or duration of each corresponding Module No. (0-15), this is designed to enable software renting or leasing. By setting parameters in this section, software vendors can set up a software module number and its corresponding start time (YY-MM-DD:HH), end time (YY-MM-DD:HH) or duration time (DD:HH). Click Add to add another module, select an item then click Edit to change your settings, or click Delete to remove the selected setting. When you click on Add, an Add Time Modules window will pop up.

Enter the module number and start time. Either the end time or duration must be entered to add a Time Module. Click ok to add this module. Your settings will be displayed in the message box.

UPT File

In the UPT File tab, if you want to generate a password for this update file, please enable the Set File Password check box and input your desired password.

Click Generate. A save file window will pop up as below, and you can set the directory to save in and a name for the update file.

Congratulations! You have generated the Update file if you see the window below.

Retrieved from "https://esecutech.com/wiki/index.php?title=UniKey_Updater_And_Generator_Tool&oldid=1345"