Security Config (security.ncconf)
The security.ncconf file stores the configuration for NCache node-level security, including the primary and optional secondary LDAP domain controllers and the users or groups configured as Node Administrators. Node Administrators can perform management and cache API operations on the secured node.
Each administrator entry includes its identity and distinguished name (DN), allowing users and groups from different directory search bases to be included in the same security configuration.
Note
You will find security.ncconf at %NCHOME%\config in Windows or /opt/ncache/config in Linux.
Security Configuration File Syntax and Structure
The security configuration file is explained below.
<cache-security enabled="True">
<ldap host="yourprimarydomain" port="389"/>
<ldap-secondary host="yoursecondarydomain" port="389"/>
<administrators>
<admin id="john_smith" dn="CN=John Smith,OU=engineers,DC=example,DC=com"/>
<group id="Engineers" dn="CN=Engineers,OU=Alachisoft,DC=org,DC=us"/>
</administrators>
</cache-security>
Security Tag Definitions and Parameters
The following section explains the tags mentioned in the file syntax.
<cache-security>
This tag specifies whether cache security is enabled.
<cache-security enabled="True">
- enabled: Determines if security is enabled or not (True/False). The default value is
False.
<ldap>
This tag contains information about the primary domain controller used for authenticating users.
<ldap host="yourprimarydomain" port="389"/>
host: Specifies the name/IP of the primary domain controller for the users.
port: Specifies the port on which the primary domain controller is running.
<ldap-secondary>
This tag contains the connection settings for an optional secondary LDAP domain controller, which serves as a backup if the primary domain controller is unavailable.
<ldap-secondary host="" port="389"/>
host: Specifies the hostname or IP address of the secondary domain controller. An empty value indicates that no secondary domain controller is configured.
port: Specifies the LDAP port for the secondary domain controller.
<administrators>
This tag contains the users and groups configured as Node Administrators. Individual users are represented by <admin> entries, while groups are represented by <group> entries. These administrators have permission to perform node management and cache API operations.
<administrators>
<admin id="john_smith" dn="CN=John Smith,OU=engineers,DC=example,DC=com"/>
<group id="Engineers" dn="CN=Engineers,OU=Alachisoft,DC=org,DC=us"/>
</administrators>
Entries can refer to users or groups selected from different search bases. Each entry retains its full distinguished name, identifying its location within the directory.
<admin>
This tag identifies an individual user configured as a Node Administrator.
<admin id="john_smith" dn="CN=John Smith,OU=engineers,DC=example,DC=com"/>
id: Specifies the user account identifier.
dn: Specifies the full distinguished name of the user in the LDAP directory, rather than the search base used to find the user.
CN: Identifies the common name of the directory entry.
OU: Identifies an organizational unit in the directory hierarchy.
DC: Identifies a domain component. For example,
DC=example,DC=comrepresents the domainexample.com.
<group>
This tag identifies a directory group configured as a Node Administrator.
<group id="Engineers" dn="CN=Engineers,OU=Alachisoft,DC=org,DC=us"/>
id: Specifies the group identifier.
dn: Specifies the full distinguished name of the group in the LDAP directory, rather than the search base used to find the group.
CN: Identifies the common name of the directory entry.
OU: Identifies an organizational unit in the directory hierarchy.
DC: Identifies a domain component. For example,
DC=example,DC=comrepresents the domainexample.com.