NKLS Configuration File

An initial configuration file named NKLS.INI must be placed in the same directory as NKLS.EXE. This file contains the initial settings for the NKLS. When the NKLS is loaded for the first time, the file will be copied to a writable folder in Windows, which will be used as the default and running configuration file.

 

When running the NKLS with GUI, the default NKLS.INI file is saved in the folder:

 

%APPDATA%\NETKEY40EK\NKLS.INI

 

When running the NKLS as a service, depending on the Windows version, the default NKLS.INI is saved in one of the following folders:

 

%ALLUSERSPROFILE%\APPLICATION DATA\NETKEY40EK\NKLS.INI, or

%ALLUSERSPROFILE%\NETKEY40EK\NKLS.INI

 

The NKLS configuration file has the following format.

 

Item

Description

[Main]

Main settings.

ServerModel

The server model must be 2.

Caption

Specify the text to be displayed on the title bar of the NKLS window (e.g. My Application 1.0). The caption helps to identify the application that the NKLS is serving. This is especially useful when multiple NKLSs are running at the same time.

Port

Specify a TCP port number for the NKLS. The port number must be different from any other port in use on the server. When multiple NKLSs are used to handle different applications, each NKLS must be assigned a different port number.

IdleTime

Specify the time (in minutes) that the application can remain connected to the NKLS without any message exchanged. When the number of concurrent clients reaches the limit, an idle connection will be disconnected as soon as a new client establishes a connection to the NKLS.

[User]

User settings.

SpecifyUserAddresses

Enable authorization based on the specified user addresses (0 = disabled; 1 = enabled).

SpecifyUserPhysicalAddresses

Enable authorization based on the specified user physical (MAC) addresses (0 = disabled; 1 = enabled).

[UserAddresses]

List of the specified user addresses.

Address<n>

Specify the client IP addresses authorized to connect to the NKLS.

[UserPhysicalAddresses]

List of the specified user physical (MAC) addresses.

Address<n>

Specify the client physical (MAC) addresses authorized to connect to the NKLS.

[Log]

Log settings.

HistoryDir

Specify the History directory (e.g. History\). When multiple NKLSs are used to handle different applications, each NKLS should be assigned a different History directory; otherwise, the log file will be overwritten.

DataDir

Specify the Data directory (e.g. Data\) to save the Roam database file (Roam.mdb). When multiple NKLSs are used to handle different applications, each NKLS should be assigned a different Data directory; otherwise, the database file will be overwritten.

[Remote]

Authentication for accessing the NKLS via NetKey Manager.

User

Assign a user ID.

Password

Assign a password

 

Below is an example of the NKLS configuration file.

 

[Main]

ServerModel=2

Caption=My Application 1.0

Port=1245

IdleTime=3

[User]

SpecifyUserAddresses=1

SpecifyUserPhysicalAddresses=1

[UserAddresses]

Address1=192.168.2.1 192.168.2.128

Address2=192.168.3.1 192.168.3.128

[UserPhysicalAddresses]

Address1=12-34-56-78-9A-BC

Address2=FE-DC-BA-98-76-54

[Log]

HistoryDir=History\

DataDir=Data\

[Remote]

User=Administrator

Password=Administrator