NCache Security

Distributed cache operates in an environment having access to many different users, where any user can change the cache configuration, perform any management operation or can have access to the cache data without any restriction. The concern of cache security arises when you are dealing with critical data or you don't want everyone to have administrative access rights to your cache server other than the list of authorized users. NCache security mechanism works with any LDAP supported Directory Services. All users are authenticated against LDAP supported Directory Services. NCache provides you with a security feature with different levels of granularity that you can implement as per your requirements.

Security Access Levels

NCache’s security feature incorporates security at two distinct access levels:

  • Administrative/Management Level
  • Cache API Level

These levels of security are intended to secure both management and client level access to your cache. By default, the security feature is disabled for both the access levels.

Administrative/Management Level Security

Management level security in NCache ensures that a remote cluster node is protected from any unauthorized user access. It is used to validate authorized users who have access to perform any management and configuration related operation on a cluster node. To secure an overall multi-node cache cluster, you must have to enable security on each individual node of the cluster. Administrative tools like Manager and command line tools are integrated with security framework and provide you with the option to perform operations in a secured environment.

To learn how to configure security on a node, see Configuring Security in NCache Administrators' guide.

What is secured by Enabling Management Level Security?

Once, you configure management level security on your server node allowing few users to have administrative permissions, no users other than those specified, will have access to perform any management operations on your node such as:

  • Create new cache
  • Remove existing cache
  • Add existing cache
  • Start cache
  • Stop cache
  • Restart cache
  • Refresh cache

Privileged System Administrator

The list of authorized users is marinated in security.conf. Only a local administrator on that machine can enable security. Users other than those configured as your node administrators are not permitted to perform any management related operation on your node. But there is one exception: a user is also granted administrative permissions if he is local system administrator on that system.

It means that a local window administrator always has administrative rights and permissions whether managerial operation is performed locally, or from any other server node, using local windows credentials. So if a node is not authorized as an administrator and you are using that node to perform an operation on your personal machine, all that you need is to provide your system credentials and you are allowed to do any remote management operation on your system.

Cache API Level Security

Cache level security in NCache ensures that cache data is protected from any unauthorized user access. Cache API level security is used to validate authorized users who try to establish a connection with cache via NCache API. By enabling cache level security, you can control whether all or few clients can access the cluster cache data for either reading or writing. Only clients verified as valid and authenticated users are allowed to perform cache level operations.

To learn how to configure security on a cache, see Configuring Security for Cache in NCache Administrators' guide.

What Is Secured by Enabling API Level Security?

Once, you configure cache level security on a cache allowing few users to have cache API authorization, no users other than those specified will have access to perform any cache operations on the cache such as:

  • Initialize cache
  • Get data
  • Add data
  • Remove/update data etc.

If security is enabled on a cache, then credentials must be provided along with the initialize cache call to establish a connection. This list of authorized users for each is maintained in the <configuration> section of config.ncconf.

Using Security in NCache

To utilize the API, include the following namespace in your application: Alachisoft.NCache.Web.Caching.

For using security after configuring security, security credentials need to be mentioned for initializing cache using CacheInitParams:

try
{
    CacheInitParams ciParam = new CacheInitParams();
    ciParam.PrimaryUserCredentials = new SecurityParams("primaryUserId", "primaryUserPassword");
    ciParam.SecondaryUserCredentials = new SecurityParams("secondaryUserId", "secondaryUserPassword");

    Cache cache = NCache.InitializeCache("myreplicatedcache", ciParam);
}
catch (Exception exp)
{
    // handle exception
}

Or as an alternative, the security credentials can be provided in the property file of your application:

./media/image1.png

try
{
    string userName = string.Empty;

    string password = string.Empty;
    if (System.Configuration.ConfigurationManager.AppSettings["Username "] != null){
      userName = System.Configuration.ConfigurationManager.AppSettings["Username"].ToString();
    }
    if (System.Configuration.ConfigurationManager.AppSettings["Password"] != null){
      password = System.Configuration.ConfigurationManager.AppSettings["Password"].ToString();
    }

    CacheInitParams cacheParam = new CacheInitParams();
    cacheParam.PrimaryUserCredentials = new SecurityParams(userName, password);

    // Initializing cache with security credential provided in web/App.config file
    Cache cache = NCache.InitializeCache("mycache", cacheParam);
}
catch (Exception ex)
{
    // handle exception
}

Troubleshooting

Alachisoft.NCache.Runtime.Exceptions.SecurityException

This exception is raised if an unauthorized user tries to perform cache operations, or wrong credential information is given in the InitializeCache() overload or in client.ncconf file.

Workaround

  1. Check if you have given correct credential information through API or in client.ncconf. A typing mistake can be the result of this exception.

  2. See if the specified user exists under given domain in LDAP. Login credentials are required to belong to any WINDOWS Server hosting the user login and running Active Directory services.

  3. Check if you have given a double slash '//' to separate domain name and User ID when passing them as a string through API. Sometimes a single slash is given, which is recognized as an escape sequence. In that case, no compile time error arises, rather it results in a security exception.