UniKey Updater And Generator Tool: Difference between revisions

From SecuTech Wiki
Jump to navigationJump to search
← Older edit

Cynthia (talk | contribs)

0 edits
Joseph (talk | contribs)
0 edits
No edit summary
Cynthia (talk | contribs)
0 edits
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[category:UniKey Application Solutions]]
[[category:UniKey Manuals]]
==<b>UniKey Updater &amp; Generator</b>==


== UniKey Remote Update ==
<b><i>Version 8.4</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>1.0</td>
  <td>1.1</td>
  <td>1.2</td>
  <td>1.3</td>
  <td>2.0</td>
  <td>2.1</td>
  <td>2.2</td>
  <td>3.0</td>
  <td>4.0</td>
  <td>5.0</td>
  <td>6.0</td>
  <td>7.0</td>
  <td>7.1</td>
  <td>7.3</td>
  <td>8.0</td>
  <td>8.1</td>
  <td>8.2</td>
  <td>8.3</td>
  <td>8.4</td>
</tr>
<tr>
  <td style="background-color: red;"><b style="color: #fff;">Date</b></td>
  <td>2006.1</td>
  <td>2006.8</td>
  <td>2006.10</td>
  <td>2006.12</td>
  <td>2007.2</td>
  <td>2007.4</td>
  <td>2007.8</td>
  <td>2008.5</td>
  <td>2008.8</td>
  <td>2009.3</td>
  <td>2010.4</td>
  <td>2010.6</td>
  <td>2010.8</td>
  <td>2010.9</td>
  <td>2012.3</td>
  <td>2012.4</td>
  <td>2016.5</td>
  <td>2016.7</td>
  <td>2018.2</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.
[[File:updater select file.png|300px|alt=select .upt file for updating with remote updater]]


=== 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. 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 (*.upt) with the UniKey Generator, specific for the intended UniKey device.
[[File:unikey updater diagram.jpeg|600px|alt=how the UniKey remote updater works]]
# The End User receives the UniKey Updater file (*.upt) sent by the Software Vender, and updates the UniKey device with new settings using UniKey Update.


== UniKey Update Generator ==
<div style="page-break-before:always"></div>
==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.


The UniKey Update Generator tool is used to creating an update file (*.upt 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.  
===Basic Settings===
In the generator window, on the Basic Settings tab, enter the UniKeys four passwords respectively.


=== Basic Settings ===
[[File:generator basic settings.png|thumb|left|500px|alt=UniKey Generator basic settings tab|The default passwords are only 1234, while for UniKey Drive the default passwords are only 12345678]]


In the Generator window, on the "Basic Settings" tab, input the four passwords of the respective UniKey device to be updated.
<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.


[[Image:UniKey_RemoteUpdate_Tool_Pic01.jpg]]
===Memory Settings===


* 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.
[[File:generator memory settings.png|500px|alt=UniKey Generator memory settings tab]]
* 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 .upt update files. <!--Check-->


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


[[Image:UniKey_RemoteUpdate_Tool_Pic02.jpg]]
[[File:generator add memory.png|300px|alt=UniKey Generator add memory (start address and length) window]]


Clicking [Add] will open the "Add Memory" window, as shown 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 also delete files that are useless.


[[Image:UniKey_RemoteUpdate_Tool_Pic03.jpg]]
===Module Settings===
Module Settings enables you to set your software module number and module value to your update file.


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].
[[File:generator module settings.png|500px|alt=UniKey Generator module settings tab]]


Memory records can be later edited or deleted from the "Memory Settings" tab.
Clicking on "Add" will bring up an "Add Module window". Enter the module number and value, using the "Auto-decrement" option will decrese the module value automatically after every use by the end user.


=== Module Settings ===
[[File:generator add module.png|left|thumb|300px|alt=UniKey Generator add module (number and value) window|UniKey Drive allows you to add modules between 0-255]]


"Module Settings" enables you to set your software module no. and module value to your update file.
<div style='clear:both'></div>


[[Image:UniKey_RemoteUpdate_Tool_Pic04.jpg]]
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.


Clicking [Add] will open the "Add Module" window, as shown below.
===Arithmetic Settings===


[[Image:UniKey_RemoteUpdate_Tool_Pic05.jpg]]
[[File:generator arithmetic settings.png|500px|alt=UniKey Generator arithmetic settings tab]]


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-->
Click "Add" to add a new algorithm.


Modules can be later edited or deleted from the "Module Settings" tab.
[[File:generator add algorithms.png|300px|alt=UniKey Generator add algorithm (start point and algorithm) window]]


=== Arithmetic Settings ===
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_Pic06.jpg]]
===Time Settings (Only for UniKey Time)===


Clicking [Add] will open the "Add Algorithm" window, as shown below.
[[File:generator time settings.png|500px|alt=UniKey Generator time settings tab]]


[[Image:UniKey_RemoteUpdate_Tool_Pic07.jpg]]
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 time 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.


<!--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.
[[File:generator add time module.png|300px|alt=UniKey Generator add time modules (number, start and end time, and duration) window]]


Algorithms can be later edited or deleted from the "Arithmetic Settings" tab.
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.


=== Time Settings (UniKey Time only) ===
===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_Pic08.jpg]]
[[File:generator upt file.png|500px|alt=UniKey Generator UPT file tab]]


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).
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.


Clicking [Add] will open the "Add Time Modules" window, as shown below.
[[File:generate save file.PNG|500px|alt=UniKey Generator save file path]]
 
[[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 ===
 
<!--J-->After settings have been configured, the .upt file containing the setting for the UniKey device 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
 
Click [Generate]. A save file window will pop up as below, and you set the directory to save in and a name for the update file.
 
[[Image:UniKey_RemoteUpdate_Tool_Pic11.jpg]]


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


[[Image:UniKey_RemoteUpdate_Tool_Pic12.jpg]]
[[File:upt file success.png|300px|alt=UPT file generated successfully]]
 
== Remote Updater ==
 
[[Image:UniKey_RemoteUpdate_Tool_Pic13.jpg]]
 
'''General Information about the Remote Updater'''
 
It is a common need for software vendors to upgrade the 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, the entire updating job 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). Only the end-user with the correct password can use the file to update the UniKey dongle.
 
[[Image:UniKey_RemoteUpdate_Tool_Pic14.jpg]]

Latest revision as of 11:03, 14 February 2018

UniKey Updater & Generator

Version 8.4

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

Remote Updater

select .upt file for updating with 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. 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.

how the UniKey remote updater works

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.

UniKey Generator basic settings tab
The default passwords are only 1234, while for UniKey Drive the default passwords are only 12345678
  • 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

UniKey Generator memory settings tab

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

UniKey Generator add memory (start address and length) window

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 also delete files that are useless.

Module Settings

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

UniKey Generator module settings tab

Clicking on "Add" will bring up an "Add Module window". Enter the module number and value, using the "Auto-decrement" option will decrese the module value automatically after every use by the end user.

UniKey Generator add module (number and value) window
UniKey Drive allows you to add modules between 0-255

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

UniKey Generator arithmetic settings tab

Click "Add" to add a new algorithm.

UniKey Generator add algorithm (start point and algorithm) window

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)

UniKey Generator time 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 time 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.

UniKey Generator add time modules (number, start and end time, and duration) window

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.

UniKey Generator UPT file tab

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.

UniKey Generator save file path

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

UPT file generated successfully

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