UniKey Assist Tool

From SecuTech Wiki
Jump to: navigation, search

UniKey Assist

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


The UniKey Assist Tool allows users to easily view diagnostic information about a particular UniKey device, and is designed to aid the troubleshooting process on the end-user side. Output from the Assist tool can provide useful information and help software vendors to determine the functioning status of a connected UniKey device.

Note: If more than a single UniKey device is plugged in, the Assist tool will only query one of the devices. To ascertain accurate information, ensure only the concerned UniKey device is plugged in.

The Assist tool for UniKey STD, PRO and Time can be found within the UniKey SDK under the directory:

UniKey SDK\Utilities\Assist\

The Assist tool for UniKey Drive can be found within the UniKey Drive SDK under the directory:

UniKey Drive SDK\Utilities\Assist\

The below sections contain UniKey Assist information including the following two parts:

  • Basic Assist
  • Advanced Assist

UniKey Assist is the testing tool that helps software vendors to trouble shoot issues at the end-user side. Pressing Check will start testing, and the result is shown in the Assist Information area. "Copy" will copy all the result onto a temporary clipboard.

UniKey Assist basic information

Basic Assist

Basic Assist is used to perform a basic/quick test. It will show if it can find a UniKey, and will display the manufacture date of the UniKey dongle. Basic Assist is made for a simple test, e.g. when an end-user meets a dongle not found problem. Basic Assist also works with UniKey network functions.

Advanced Assist

Apart from the Basic Assist, Advanced Assist can test UniKey APIs and show the UniKey dongle version. It will also show the type of UniKey.

UniKey Assist advanced information

In order to perform an advanced assist, password 1 and password 2 are needed (by default these are set to 1234 for both password 1 and 2).

NetUniKey Configuration File

You can use UniKey Assist to test UniKey network functions. This file can be found inside the Unikey Assist tool folder. UniKey Network Assist location

This can be done because UniKey Assist will load NetUniKey.ini when it starts. If the file NetUniKey.ini is not found, it will try to find a local UniKey, and then search for a UniKey on the network. UniKey Assist will broadcast to find a UniKey on the network if it cannot find the UniKey with a pre-fixed NetUniKey server IP address. This is the default setings, which can be seen in the picture below:

UniKey Network Assist NetUniKey.ini content

If no such found is found in the "for network" folder, you can generate a new NetUniKey.ini file from the Console under network settings.

UniKey Console device network tab

As shown, the following settings are important to make sure that your network settings is working correctly:

1. Server IP: Server's IP address in the network. This address will guide clients to find the server in the network.

2. Server port: Server port is the port to build communications between client and server.

3. Timeout: Time-out defines the maximum waiting period. If the client sends a request to the server, but the server does not send a response back in the set time, then the client is denied access. Default time-out period is 5 seconds.

4. Access mode: The method for NetUniKey Clients to access the NetUniKey Server. If you set it to access by IP, NetUniKey Server accepts only ONE client per IP. If this value is set to access by process, the NetUniKey client from the same process can only be accepted once. If it is set to access by thread, NetUniKey can be accepted in any thread. Access by shared IP means all requests from a single IP will be counted as 1. To facilitate setting other devices with the same configuration, you can save your configuration information into a file, or to update a device remotely, you can generate an update file.

5. Working mode: Working mode specifies how the UniKey Client will operate. If this value is set to local only, the NetUniKey Client will only work with a UniKey dongle attached to a local USB port. If this value is local->network, the UniKey Client will check for a local UniKey dongle attached to a USB port first, if this fails, it will try to search for the UniKey dongle attached to the UniKey server in the network. If you set it to network only, the NetUniKey Client will only work with the UniKey dongle attached to the UniKey server. When this value is set to network->local, the NetUniKey client will try to connect with the UniKey dongle attached to UniKey server first, and if it fails, it will try to load a local UniKey attached to a USB port.

6. Searching mode: Search mode sets how UniKey clients will try to find a UniKey dongle on the network. Local only is used for connecting to the server by using the server IP set in the configuration file. If it is set to local->broadcast, the UniKey client will try to use the information in the configuration file first, if this fails, the UniKey clients will broadcast to the local network to find the UniKey. If set to broadcast->local, the UniKey clients will broadcast to the network first, and will try to connect to the UniKey specified in NetUniKey configuration file when they cannot find any UniKey via the broadcast. You can save this configuration file by clicking on Save, or read the previous client settings file by clicking on Read.

Troubleshooting with UniKey Assist

see UniKey Hardware Troubleshooting