UniKey Network Monitor Tool: Difference between revisions

From SecuTech Wiki
Jump to navigationJump to search
← Older edit

Cynthia (talk | contribs)

0 edits
Bao (talk | contribs)
0 edits
m Added to manuals page
Cynthia (talk | contribs)
0 edits
 
(7 intermediate revisions by 2 users not shown)
Line 7: Line 7:
=== Install UniKey Network Service ===
=== Install UniKey Network Service ===


To install the service, navigate to <code>UniKey SDK\Network\Server\Network.Server.ia32</code> and run "Install.exe" as administrator.
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.


A command-line window will pop up, as shown below.
[[Image:UniKey_Network_Monitor_Pic03.jpg|alt=command-line application]]
 
[[Image:UniKey_Network_Monitor_Pic03.jpg]].


There are two options:
There are two options:
Line 20: Line 18:
</pre>
</pre>


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.
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 ===
=== 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.
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 ==
== UniKey Network Server Console ==
Line 38: Line 37:
=== Monitor ===
=== Monitor ===


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


*Client IP Address – IP address of the connected client
* Client IP Address – IP address of the connected client
*Computer Name – Computer name of the connected client
* Computer Name – Computer name of the connected client
*[Client Working] Mode – How the client found UniKey<!--? Check-->
* Mode - Working mode of a connected client.
*HID – The HID of the client's UniKey device
* HID – The HID of the client's UniKey device
*GUID – A unique ID assigned to each connected client.
* GUID – A unique ID assigned to each connected client.


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


Users can click [Refresh] to update the list of connected clients.
[[Image:UniKey_Network_Monitor_Pic05.jpg|alt=UniKey Network Server Console Monitor tab]]


[[Image:UniKey_Network_Monitor_Pic05.jpg]]
==== Disconnect an IP ====


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


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_Pic06.jpg|alt=UniKey Network Server Console Monitor tab, disconnect user]]


[[Image:UniKey_Network_Monitor_Pic06.jpg]]


=== Service Manager ===
=== Service Manager ===


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


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


You can start or stop Service and Network just by clicking the [Start] or [Stop] button respectively.
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.
 
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 ====
==== 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.
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.


[[Image:UniKey_Network_Monitor_Pic08.jpg]]
[[Image:UniKey_Network_Monitor_Pic08.jpg|alt=UniKey Network Server Console Network stopped]]


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


By Picking the Auto Start option, you can let the service run automatically when the server starts.
===IP Blacklist===
 
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.
IP addresses listed in in the IP blacklist cannot connect to the server.


[[Image:UniKey_Network_Monitor_Pic09.jpg]]
[[Image:UniKey_Network_Monitor_Pic09.jpg|alt=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.
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 ====
==== 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.
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.


[[Image:UniKey_Network_Monitor_Pic10.jpg]]
[[Image:UniKey_Network_Monitor_Pic10.jpg|alt=UniKey Network Server start and end IP address]]


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


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


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


Click [Refresh] to update Black IP List.


=== White IP list ===
===IP Whitelist===


IP addresses listed in the IP whitelist are the only IP addresses that can connect to the server.
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]])


The configuration of White IP List is same as the configuration of Black IP List (see [[#Blacklist an IP address]])
[[Image:UniKey_Network_Monitor_Pic12.jpg|alt=UniKey Network Server Console IP whitelist]]
 
[[Image:UniKey_Network_Monitor_Pic12.jpg]]


== Client Configuration ==
== 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.
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, under the directory <code>UniKey SDK\Network\Client</code>.
Navigate to the UniKey Network Client, located in the directory <code>UniKey SDK\Network\Client</code>


[[Image:UniKey_Network_Monitor_Pic13.jpg]]
[[Image:UniKey_Network_Monitor_Pic13.jpg|alt=Libraries and Samples folder]]


There are two sub-folders:  
There are two sub-folders:


#Libraries: Includes all the libraries for various programming languages for clients
# Libraries: Includes all UniKey libraries for various programming languages for clients.
#Samples: Includes all the samples for various programming languages for clients  
# Samples: Includes all the samples for various programming languages for clients.


=== Configuration file ===
=== Configuration file ===


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


[[Image:UniKey_Network_Monitor_Pic14.jpg]]
[[Image:UniKey_Network_Monitor_Pic14.jpg|alt=NetUniKey.ini opened in Notepad]]


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


'''WorkingMode''' defines how the client find UniKey hardware, and there are 4 options:  
<b>WorkingMode</b> defines how the clients find UniKey hardware; there are 4 options:  


#Client will only try to find UniKey from local computer.
# Client will only try to find a UniKey from a local computer.
#Client will only find UniKey from network
# Client will only try to find a UniKey from a network.
#The default setting, client will firstly find UniKey from local computer, if not find, it will find UniKey from 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 firstly try to find UniKey from network, and if not find, it will find UniKey from local computer.
# 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 find UniKey from network, and there are 3 options:
<b>AccessMode</b> defines how the client finds a UniKey from network; there are 3 options:


#Per IP address mode, which indicating you can do logon UniKey(logon UniKey as a Client User) once for one computer.
# Per IP address mode: indicates you can log in to UniKey (as a client user) once for one computer.
#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.
# 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, indicating you can do logon UniKey many times for one application and you can run many applications to logon 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.


'''ServerIP''': Refers to the server's IP address
<b>ServerIP</b>: Refers to the server's IP address.


'''ServerIP2''': Optional, refers to the second server's IP address
<b>ServerIP2</b>: Optional, refers to the second server's IP address.


'''Port''': The connection port number
<b>Port</b>: The connection port number.


'''TimeOut''': Send/receive out value in second
<b>TimeOut</b>: Send/receive time out displayed in seconds.


=== Alternative methods of configuration ===
=== Alternative methods of configuration ===


The other way is to use API in the libraries, the steps are shows as below:
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.
 
<pre>
retcode = UniKey_Find(&amp;handle[0], &amp;lp1, &amp;lp2);
</pre>
 
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.
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>


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


== Troubleshooting ==
== 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"