UniKey Network Monitor Tool

UniKey Network Service

The NetUniKey service is an application that runs in the background and enables network connectivity for UniKey devices to operate over a network.

Install UniKey Network Service

To install the service, navigate to UniKey SDK\Network\Server\Network.Server.ia32 and run "Install.exe" as administrator.

A command-line window will pop up, as shown below.

.

There are two options:

[A] Install the NetUniKey service and Run it now
[B] Uninstall the NetUniKey service

Input "A" and press Enter to install the service. After installation has been successful, the command-line window will close and the service will automatically run.

Uninstall UniKey Network Service

To uninstall UniKey Network Service, repeat the above steps, and input B to uninstall the service automatically. After uninstalling successfully, the command-line window will close.

UniKey Network Server Console

The UniKey Network Server Console is a tool to monitor client connections, configure settings, and manage black and white IP Lists.

Note: The UniKey Network Service must be running to use the UniKey Network Server Console.

To run the network server console, run "NetUniKeyServer.exe" from the directory UniKey SDK\Network\Server\Network.Server.ia32.

The four tabs in the "UniKey Network Server Console" window are Monitor, Service Manager, Black IP List and White IP List.

Monitor

Under the "Monitor" tab, connected clients are listed with information including:

• Client IP Address – IP address of the connected client
• Computer Name – Computer name of the connected client
• [Client Working] Mode – How the client found UniKey
• HID – The HID of the client's UniKey device
• GUID – A unique ID assigned to each connected client.

Connected users can

Users can click [Refresh] to update the list of connected clients.

Disconnect an IP

To disconnect a connection with the corresponding client, you can select that item, then click [Kill] or click [Kill All] to disconnect all connected clients.

Service Manager

By clicking the Service Manage tag, you can check the server's status and configure the server.

You can start or stop Service and Network just by clicking the [Start] or [Stop] button respectively.

The green dot next to Service and Network indicate both of them are working properly. If the dot is red, it indicates that the corresponding function has been stopped.

Server Configuration

When the server has more than one IP Address, click the Server IP address drop down menu, you can select different IP Address as the server's address. And define the connect port value.

Times limit(s) – defines an interval that the server will check client connection. If the client has no response in that period, the server will close the connection.

By Picking the Auto Start option, you can let the service run automatically when the server starts.

Click [Refresh], you can update the server status, and click [OK] to confirm all settings.

Black IP List

IP addresses listed in in the IP blacklist cannot connect to the server.

To enable this function, tick the "Enable Black List" checkbox, and use [Add] and [Delete] to add and remove clients to/from the blacklist, respectively.

Blacklist an IP address

Click [Add]. A "Server" window will popup. Input the start and end IP address range in the fields [Start IP Address] and [End IP Address], respectively.

Click [OK] to confirm. The IP address range will be added to the list.

To delete an entry from the list, select the item and click [Delete].

Click [Refresh] to update Black IP List.

White IP list

IP addresses listed in the IP whitelist are the only IP addresses that can connect to the server.

The configuration of White IP List is same as the configuration of Black IP List (see #Blacklist an IP address)

Client Configuration

In this part, we will describe how to configure the client computer, including working mode, access mode and Server information. To set up the working mode and access mode there are two ways, by modifying the NetUniKey.ini file or by using API. We will introduce NetUniKey.ini file modification first.

Navigate to the UniKey Network Client, under the directory UniKey SDK\Network\Client.

There are two sub-folders:

1. Libraries: Includes all the libraries for various programming languages for clients
2. Samples: Includes all the samples for various programming languages for clients

Configuration file

Open the Libraries folder and open the NetUniKey.ini file or in your text editor of your choice.

In this file you can configure your client computer.

WorkingMode defines how the client find UniKey hardware, and there are 4 options:

1. Client will only try to find UniKey from local computer.
2. Client will only find UniKey from network
3. The default setting, client will firstly find UniKey from local computer, if not find, it will find UniKey from network.
4. Client will firstly try to find UniKey from network, and if not find, it will find UniKey from local computer.

AccessMode defines how the client find UniKey from network, and there are 3 options:

1. Per IP address mode, which indicating you can do logon UniKey(logon UniKey as a Client User) once for one computer.
2. Per process mode, indicating you can do logon UniKey for one application once, and you can run many applications to logon UniKey on one computer.
3. Per thread mode, indicating you can do logon UniKey many times for one application and you can run many applications to logon UniKey on one computer.

ServerIP: Refers to the server's IP address

ServerIP2: Optional, refers to the second server's IP address

Port: The connection port number

TimeOut: Send/receive out value in second

Alternative methods of configuration

The other way is to use API in the libraries, the steps are shows as below:

For the UniKey_Find function, you need to assign a value to lp1 and lp2 parameters.

retcode = UniKey_Find(&handle[0], &lp1, &lp2);

lp1 and lp2 are WorkingMode and AccessMode respectively.

If you want to modify the WorkingMode and the AccessMode directly from the NetUniKey.ini file, please assign lp1's value and lp2's value greater than 5.

The ServerIP in NetUniKey.ini file should be the same as the server's IP address. Please modify the ServerIP according to the server's IP address.

Troubleshooting

The 105 error code is caused by firewall. It is NECESSARY to close the firewall at both the server side and the client side.