UniKey Network Monitor 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
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[category:UniKey Network Monitor Tool]]
[[category:UniKey Manuals]]
[[category:UniKey_Tools]]


= Getting Started =
== UniKey Network Service ==


== Install 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.


The NetUniKey service is an application that runs in the background, which enables the network connections for UniKey dongles to operate over a network.
=== Install UniKey Network Service ===


To install the service, please navigate to the network folder:UniKey SDK->Network->Server->Network.Server.ia32.
To install the service, navigate to <code>UniKey SDK\Network\Server\Network.Server.ia32</code> and run Install.exe as an administrator. A command-line window will pop up, as shown below.


[[Image:UniKey_Network_Monitor_Pic01.jpg]]
[[Image:UniKey_Network_Monitor_Pic03.jpg|alt=command-line application]]
 
Open the Server folder and right click on the “Install.exe” icon.
 
[[Image:UniKey_Network_Monitor_Pic02.jpg]]
 
Click on “Run as administrator”
 
A command-line installation window will pop up
 
[[Image:UniKey_Network_Monitor_Pic03.jpg]]


There are two options:
There are two options:


<pre>
[A] Install the NetUniKey service and Run it now
[A] Install the NetUniKey service and Run it now
[B] Uninstall the NetUniKey service
[B] Uninstall the NetUniKey service
</pre>


Enter A and press enter to install
Input "A" (without quotes) 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 please repeat the same operation as installation of the UniKey Network Service, when the command-line window appears, please input b and press enter. The service will uninstall automatically. After uninstalling successfully, the command-line window will close.
 
= Network Server Console =
 
UniKey Network Server Console is a tool that helps users to monitor client connections, set up servers, and manage black and white IP Lists.
 
Please double Click on the “NetUniKeyServer” icon in the Server folder.
 
[[Image:UniKey_Network_Monitor_Pic04.jpg]]
 
The UniKey Network Server Console will appear.
 
In the Monitor section, it shows the connected clients in detail, including:
 
• Client IP Address
 
• computer name
 
• Client working Mode – how the Client find UniKey
 
• HID – UniKey HID which the client connect to
 
• GUID – each connection will be assigned with a unique ID
 
Users can click [Refresh] button to update the server status
 
[[Image:UniKey_Network_Monitor_Pic05.jpg]]
 
== 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 connection.
=== Uninstall UniKey Network Service ===


[[Image:UniKey_Network_Monitor_Pic06.jpg]]
To uninstall UniKey Network Service, repeat the above steps, and input "B" (without quotes) to uninstall the service automatically. After uninstalling successfully, the command-line window will close.


== Service Manager ==


By clicking the Service Manage tag, you can check the server’s status and configure the server.
== UniKey Network Server Console ==


[[Image:UniKey_Network_Monitor_Pic07.jpg]]
The UniKey Network Server Console is a tool to monitor client connections, configure settings, and manage black and white IP Lists.


You can start or stop Service and Network just by clicking the [start] or [Stop] button respectively.
:Note: The UniKey Network Service must be running to use the UniKey Network Server Console.


The green dot next to Service and Network indicate both of them are working properly. If the dot turns red, it indicates that the corresponding function has been stopped.
To run the network server console, run "NetUniKeyServer.exe" from the directory <code>UniKey SDK\Network\Server\Network.Server.ia32</code>.


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


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.
=== Monitor ===


[[Image:UniKey_Network_Monitor_Pic08.jpg]]
Under the Monitor tab, connected clients are listed with information including:


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.
* Client IP Address – IP address of the connected client
* Computer Name – Computer name of the connected client
* Mode - Working mode of a connected client.
* HID – The HID of the client's UniKey device
* GUID – A unique ID assigned to each connected client.


By Picking the Auto Start option, you can let the service run automatically when the server starts.
Users can click Refresh to update the list of connected clients.


Click [Refresh], you can update the server status, and click [OK] to confirm all settings.
[[Image:UniKey_Network_Monitor_Pic05.jpg|alt=UniKey Network Server Console Monitor tab]]


== Black IP list ==
==== Disconnect an IP ====


IP Addresses which are listed in black IP list cannot connect to the server.
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.


[[Image:UniKey_Network_Monitor_Pic09.jpg]]
[[Image:UniKey_Network_Monitor_Pic06.jpg|alt=UniKey Network Server Console Monitor tab, disconnect user]]


To enable this function just pick the “Enable Black List” option on top of the panel.


'''''Add an IP address to the black list'''''
=== Service Manager ===


Click [Add]. A Server window will pop up, and input Start IP Address and End IP Address.
By clicking the Service Manage tab, you can check the server's status and configure the server.


[[Image:UniKey_Network_Monitor_Pic10.jpg]]
[[Image:UniKey_Network_Monitor_Pic07.jpg|alt=UniKey Network Server Console Service Manage tab]]


Click [OK] to confirm
You can start or stop the Service and Network just by clicking the respective "Start" or "Stop" button. 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 stopped functioning.


[[Image:UniKey_Network_Monitor_Pic11.jpg]]
==== Server Configuration ====


The segment of IP Addresses will be added into the black IP list, and is shown in the message box.
When the server has more than one IP Address, click the Server IP Address drop-down menu; you can select different IP addresses as the server's address, and define the connection port value.


To delete an item from the list, just select the item and click [delete]
[[Image:UniKey_Network_Monitor_Pic08.jpg|alt=UniKey Network Server Console Network stopped]]


Click [Refresh] to update Black IP List
Times limit(s) – defines a time interval (in seconds) that the server will check client connections. If the client has no response in that period, the server will close the connection. By checking the Auto Start option, you can let the service run automatically when the server starts. Clicking Refresh will update the server status, and then click OK to confirm all settings.


== White IP list ==
===IP Blacklist===


Only IP Addresses listed in this White IP List can connect to the server.
IP addresses listed in in the IP blacklist cannot connect to the server.


The configuration of White IP List is same as the configuration of Black IP List
[[Image:UniKey_Network_Monitor_Pic09.jpg|alt=UniKey Network Server Console IP blacklist tab]]


[[Image:UniKey_Network_Monitor_Pic12.jpg]]
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.
<font class="Apple-style-span" size="3"><span class="Apple-style-span" style="font-size: 13px;"><font class="Apple-style-span" size="7"><span class="Apple-style-span" style="font-size: 25px;">
</span></font></span></font>


= Client Configuration =
==== Blacklist an IP Address ====


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.
By clicking 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.


Open the Client Folder in the SDK, located in:
[[Image:UniKey_Network_Monitor_Pic10.jpg|alt=UniKey Network Server start and end IP address]]


SDK-&gt;Network-&gt;Client
Click OK to confirm these details; the IP address range will be added to the list.


[[Image:UniKey_Network_Monitor_Pic13.jpg]]
[[Image:UniKey_Network_Monitor_Pic11.jpg|alt=UniKey Network Server Console IP address added to blacklist]]


There are two sub-folders:
To delete an entry from the list, select the item and click Delete. Click Refresh to update the IP blacklist.


'''''Libraries'''''


Includes all the libraries for various programming languages for clients
===IP Whitelist===


'''''Samples'''''
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 similar to the configuration of Black IP List (see [[#Blacklist an IP Address]])


Includes all the samples for various programming languages for clients
[[Image:UniKey_Network_Monitor_Pic12.jpg|alt=UniKey Network Server Console IP whitelist]]


== Configuration file ==
== Client Configuration ==


Open the Libraries Folder and double click NetUniKey.ini file, and The file will be opened by Notepad.;
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 the API. We will introduce NetUniKey.ini file modification first.


[[Image:UniKey_Network_Monitor_Pic14.jpg]]
Navigate to the UniKey Network Client, located in the directory <code>UniKey SDK\Network\Client</code>


In this file you can configure your client computer.
[[Image:UniKey_Network_Monitor_Pic13.jpg|alt=Libraries and Samples folder]]


'''WorkingMode''' defines how the client find Unikey hardware, and there are 4 options:  
There are two sub-folders:


1. Client will only try to find Unikey from local computer.
# Libraries: Includes all UniKey libraries for various programming languages for clients.
# Samples: Includes all the samples for various programming languages for clients.


2. Client will only find UniKey from network
=== Configuration file ===


3. The default setting, client will firstly find UniKey from local computer, if not find, it will find Unikey from network.
Open the Libraries folder and open the NetUniKey.ini file in a text editor of your choice.


4. Client will firstly try to find UniKey from network, and if not find, it will find UniKey from local computer.
[[Image:UniKey_Network_Monitor_Pic14.jpg|alt=NetUniKey.ini opened in Notepad]]


'''AccessMode''' defines how the client find UniKey from network, and there are 3 options:
In this file you can configure your client's computer.


0. Per IP address mode, which indicating you can do logon UniKey(logon UniKey as a Client User) once for one computer.
<b>WorkingMode</b> defines how the clients find UniKey hardware; there are 4 options:


1. 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.
# Client will only try to find a UniKey from a local computer.
# Client will only try to find a UniKey from a network.
# Under the default setting, client will first attempt to find a UniKey from a local computer, if not, then it will attempt to find a UniKey from the network.
# Client will first try to find a UniKey from the network, if not, it will attempt to find a UniKey from a local computer.


2. 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.
<b>AccessMode</b> defines how the client finds a UniKey from network; there are 3 options:


'''ServerIP''': Refers to the server’s IP address
# Per IP address mode: indicates you can log in to UniKey (as a client user) once for one computer.
# Per process mode: indicates you can log in to UniKey for one application once, and you can run many applications that require a UniKey on one computer.
# Per thread mode: indicates you can log in to UniKey many times for one application and you can run many applications that require a UniKey on one computer.


'''Port''': The connection port number
<b>ServerIP</b>: Refers to the server's IP address.


'''TimeOut''': Send/receive out value in second
<b>ServerIP2</b>: Optional, refers to the second server's IP address.


== Alternative methods of configuration ==
<b>Port</b>: The connection port number.


The other way is to use API in the libraries, the steps are shows as below:
<b>TimeOut</b>: Send/receive time out displayed in seconds.


For the UniKey_Find function, you need to assign a value to lp1 and lp2 parameters.
=== Alternative methods of configuration ===


retcode = UniKey_Find(&amp;handle[0], &amp;lp1, &amp;lp2);
Another way to configure the network monitoring tool is to use the respective library API, the steps are shown as below:


lp1 and lp2 are WorkingMode and AcessMode respectively.
For the <code>UniKey_Find</code> function, you need to assign a value to lp1 and lp2 parameters. For example, in C this would be written as: <code>retcode = UniKey_Find(&amp;handle[0], &amp;lp1, &amp;lp2);</code>


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.
<b>lp1 and lp2 are WorkingMode and AccessMode respectively</b>. If you want to modify the WorkingMode and the AccessMode directly from the NetUniKey.ini file, please assign lp1 and lp2 a value greater than 5. The ServerIP in the NetUniKey.ini file should be the same as the server's IP address. Please modify the ServerIP according to the server's IP address.


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.
The 105 error code is caused by a firewall. It is NECESSARY to close the firewall at both the server side and the client side in order to proceed.

Latest revision as of 15:39, 13 February 2018


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 an administrator. A command-line window will pop up, as shown below.

command-line application

There are two options: 

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

Input "A" (without quotes) 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" (without quotes) 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
  • Mode - Working mode of a connected client.
  • HID – The HID of the client's UniKey device
  • GUID – A unique ID assigned to each connected client.

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

UniKey Network Server Console Monitor tab

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.

UniKey Network Server Console Monitor tab, disconnect user


Service Manager

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

UniKey Network Server Console Service Manage tab

You can start or stop the Service and Network just by clicking the respective "Start" or "Stop" button. 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 stopped functioning.

Server Configuration

When the server has more than one IP Address, click the Server IP Address drop-down menu; you can select different IP addresses as the server's address, and define the connection port value.

UniKey Network Server Console Network stopped

Times limit(s) – defines a time interval (in seconds) that the server will check client connections. If the client has no response in that period, the server will close the connection. By checking the Auto Start option, you can let the service run automatically when the server starts. Clicking Refresh will update the server status, and then click OK to confirm all settings.

IP Blacklist

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

UniKey Network Server Console IP blacklist tab

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

By clicking 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.

UniKey Network Server start and end IP address

Click OK to confirm these details; the IP address range will be added to the list.

UniKey Network Server Console IP address added to blacklist

To delete an entry from the list, select the item and click Delete. Click Refresh to update the IP blacklist.


IP Whitelist

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 similar to the configuration of Black IP List (see #Blacklist an IP Address)

UniKey Network Server Console IP whitelist

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 the API. We will introduce NetUniKey.ini file modification first.

Navigate to the UniKey Network Client, located in the directory UniKey SDK\Network\Client

Libraries and Samples folder

There are two sub-folders:

  1. Libraries: Includes all UniKey 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 in a text editor of your choice.

NetUniKey.ini opened in Notepad

In this file you can configure your client's computer.

WorkingMode defines how the clients find UniKey hardware; there are 4 options:

  1. Client will only try to find a UniKey from a local computer.
  2. Client will only try to find a UniKey from a network.
  3. Under the default setting, client will first attempt to find a UniKey from a local computer, if not, then it will attempt to find a UniKey from the network.
  4. Client will first try to find a UniKey from the network, if not, it will attempt to find a UniKey from a local computer.

AccessMode defines how the client finds a UniKey from network; there are 3 options:

  1. Per IP address mode: indicates you can log in to UniKey (as a client user) once for one computer.
  2. Per process mode: indicates you can log in to UniKey for one application once, and you can run many applications that require a UniKey on one computer.
  3. Per thread mode: indicates you can log in to UniKey many times for one application and you can run many applications that require a 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 time out displayed in seconds.

Alternative methods of configuration

Another way to configure the network monitoring tool is to use the respective library API, the steps are shown as below:

For the UniKey_Find function, you need to assign a value to lp1 and lp2 parameters. For example, in C this would be written as: 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 and lp2 a value greater than 5. The ServerIP in the 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 a firewall. It is NECESSARY to close the firewall at both the server side and the client side in order to proceed.

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