• Products
  • Solutions
  • Customers
  • Resources
  • Company
  • Pricing
  • Download
Try Playground
  • Client Side API Programming
  • Security API
  • Login with Credentials
Show / Hide Table of Contents
  • Programmer's Guide
  • Setting Up Development Environment
    • .NET
      • Client API Prerequisites
      • Server-side API Prerequisites
    • Java
      • Client API Prerequisites
      • Server-side API Prerequisites
    • Python
      • Client API Prerequisites
    • Node.js
      • Client API Prerequisites
  • Client Side API Programming
    • Error Handling
    • Troubleshooting
    • Cache Keys and Data
    • How to Connect to Cache
    • Basic Operations - An Overview
      • Add Data
      • Update/Insert Data
      • Retrieve Data
      • Remove Data
    • Groups
      • Overview
      • Add/Update Data with Groups
      • Retrieve Data with Groups
      • Remove Data with Group
      • Search Group Data Using SQL
      • Delete Group Data Using SQL
    • Tags
      • Overview
      • Add/Update Data with Tags
      • Retrieve Data with Tags
      • Remove Data with Tags
      • Search Tag Data Using SQL
      • Delete Tag Data Using SQL
    • Named Tags
      • Overview
      • Add/Update Data with Named Tags
      • Remove Data with Named Tags
      • Search Data with Named Tags Using SQL
      • Delete Data with Named Tags Using SQL
    • Expirations
      • Overview
      • Absolute Expiration
      • Sliding Expiration
    • Data Dependency
      • Key Dependency
      • Multi-Cache Dependency
    • Dependency on Database
      • SQL Server
      • Oracle
      • OleDB with Polling
      • CLR Procedures in SQL Server
    • Dependency on External Source
      • File Dependency
      • Custom Dependency
      • Aggregate Dependency
    • Locks
      • Types of Locking
      • Pessimistic Locking
      • Optimistic Locking
    • SQL Query
      • Overview
      • Define Indexes Programmatically
      • Query with ExecuteReader and ExecuteScalar
      • Delete Data with ExecuteNonQuery
      • SQL Reference
    • LINQ Query
      • Overview
      • LINQ Query for Objects
      • LINQ Reference
    • Data Structures
      • Overview
      • List
      • Queue
      • Set
      • Dictionary
      • Counter
      • Invalidation Attributes
      • Searchable Attributes
      • Query on Data Structures
      • Remove from Data Structure
    • Events
      • Cache Level Events
      • Item Level Events
      • Management Level Events
    • Pub/Sub Messaging
      • Overview
      • Topics
      • Publish Messages
      • Subscribe to a Topic
      • Pub/Sub Events
    • Continuous Query
      • Overview
      • Use Continuous Query
    • Stream Processing
      • Add/Update Stream Data
      • Retrieve Stream Data
    • JSON
      • Overview
      • Use JSON Objects
      • Query JSON Data
    • Security API
      • Login with Credentials
    • Management API
    • Clear Cache
    • Error Logging
    • Location Affinity
  • Server-side API Programming
    • Loader and Refresher
      • Overview
      • Implement Loader and Refresher
      • Components of Loader/Refresher
    • Data Source Providers
      • Read-through
        • Implement Read-through
        • Use Read-through
      • Write-through
        • Implement Write-through
        • Use Write-through
        • Use Write-behind
    • Custom Dependency
      • Implement Extensible Dependency
      • Implement Bulk Extensible Dependency
      • Implement Notify Extensible Dependency
    • Bridge Conflict Resolver
    • Entry Processor
      • Overview
      • Implement Entry Processor
    • MapReduce
      • Overview
      • Implement MapReduce
      • Use MapReduce
    • MapReduce Aggregator
      • Overview
      • Implement and Use Aggregator
    • Compact Serialization
  • Client Side Features
    • ASP.NET Core Caching
      • Session Storage
        • Session Provider
        • IDistributedCache
        • Sessions Usage
        • Multi-site Session Provider
        • Session Sharing with ASP.NET
      • SignalR
        • NCache Extension for SignalR Core
      • Response Caching
        • Configure and Use
        • Configure with IDistributedCache
      • Data Caching
        • NCache API
        • IDistributedCache API
      • Data Protection Provider
        • Configure
    • Java Web App Caching
      • Web Sessions
        • Overview
        • Configure App
          • Add Maven Dependencies
          • Deploy Application
        • Multi-site Sessions
    • Node.js App Caching
      • Web Sessions
    • ASP.NET Caching Benefits and Overview
      • ASP.NET Session State Provider Properties
      • Multi-region ASP.NET Session State Provider Configuration
      • Session Sharing between ASP.NET and ASP.NET Core
      • ASP.NET SignalR Backplane
        • NCache Extension for SignalR
      • ASP.NET View State Caching
        • View State Content Optimization Configuration
        • Group View State with Sessions
        • Limit View State Caching
        • Page Level Grouping
      • ASP.NET Output Cache
        • Output Caching Provider Overview
        • Output Cache with Custom Hooks
  • .NET Third Party Integrations
    • Entity Framework (EF) Core
      • Installation
      • Configure
      • EF Core Extension Methods
        • Extension Methods
        • Cache Handle
        • Caching Options
        • Query Deferred API
      • Logging in EF Core
    • Entity Framework EF 6
      • EF Second Level Cache
      • EF Caching Resync Provider
      • EF Caching Configuration File
    • NHibernate
      • Second Level Cache
      • Query Caching
      • Synchronize Database with Cache
    • Debug NCache Providers in Visual Studio
  • Java Third Party Integrations
    • Hibernate
      • Second Level Cache
      • Configure Cacheable Objects and Regions
      • Configure Application
      • Query Caching
    • Spring
      • Overview
      • Use NCache with Spring
        • Configure Generic Provider
        • Configure JCache Spring Caching Provider
        • Configure Caching Declaration
        • Configure Spring Sessions
    • JCache API
      • CRUD Operations
      • Expiration
      • Events
  • Third-Party Wrappers
    • AppFabric to NCache Migration
      • AppFabric API vs. NCache API
      • Configuration Differences Between AppFabric and NCache
      • Migrating from an AppFabric Application to NCache
    • Redis to NCache Migration
      • Redis to NCache Migration
    • Memcached Wrapper
      • Memcached Gateway Approach
      • Memcached Client Plugin for .NET

How to use Security?

NCache provides two ways to secure your cache and prevent unwanted or unauthorized access to your NCache cluster. First, you can configure Client Node Security (and its respective cache security) using the NCache Management Center, allowing the clients connected with this node to access the cache with the same credentials you provided while configuring Client Node Security. No code change is required to do so.

Note
  • This feature is only available in NCache Enterprise.
  • This feature is provided for both Windows and Linux .NET applications.

Alternatively, you can configure it programmatically when the NCache client is not installed on your system, as demonstrated below.

Prerequisites

  • .NET
  • Java
  • Python
  • Node.js
  • To learn about the standard prerequisites required to work with all NCache client-side features, please refer to the given page on Client-Side API Prerequisites.
  • Add System.Configuration assembly through the Reference Manager.
  • For API details, refer to: ICache, CacheConnectionOptions, GetCache, CacheManager, Credentials.
  • To learn about the standard prerequisites required to work with all NCache client-side features, please refer to the given page on Client-Side API Prerequisites.
  • For API details, refer to: Cache, getCache, Credentials, CacheManager, CacheConnectionOptions.
  • To learn about the standard prerequisites required to work with all NCache client-side features, please refer to the given page on Client-Side API Prerequisites.
  • For API details, refer to: Cache, Credentials, get_cache, CacheManager, CacheConnectionOptions.
  • To learn about the standard prerequisites required to work with all NCache client-side features, please refer to the given page on Client-Side API Prerequisites.
  • For API details, refer to: Cache, CacheConnectionOptions, getCache, Credentials, CacheManager.

Here's an example which shows how to enable security on the cache. Once security is configured on the cache, security credentials need to be mentioned for initializing cache, using CacheConnectionOptions.

  • .NET
  • Java
  • Python
  • Node.js
string cacheName = "demoCache";

// Use CacheConnectionOptions to provide credentials
var options = new CacheConnectionOptions();

// Use UserCredentials property to assign credentials
options.UserCredentials = new Credentials("your-username", "your-password");

// Connecting to cache with security credentials
ICache cache = CacheManager.GetCache(cacheName, options);
String cacheName = "demoCache";

// Use CacheConnectionOptions to provide credentials
CacheConnectionOptions options = new CacheConnectionOptions();

// Use UserCredentials property to assign credentials
options.setUserCredentials(new Credentials("john", "password"));

// Connecting to cache with security credentials
Cache cache = CacheManager.getCache(cacheName, options);
# Initialize credentials
user_id = "UserId"
password = "UserPassword"
cache_name = "demoCache"

# Use CacheConnectionOptions to provide credentials
options = ncache.CacheConnectionOptions()

# Use UserCredentials property to assign credentials
credentials = ncache.Credentials(user_id, password)
options.set_user_credentials(credentials)

# Connecting to cache with security credentials
cache = ncache.CacheManager.get_cache(cache_name, options)
// InItialize credentials
let userId = "UserId";
let password = "UserPassword";
let cacheName = "demoClusteredCache";

// Use CacheConnectionOptions to provide credentials
let options = new ncache.CacheConnectionOptions();

// Use UserCredentials property to assign credentials
let credentials = new ncache.Credentials(userId, password);
options.setUserCredentials(credentials);

// Connecting to cache with security credentials
let cache = await ncache.CacheManager.getCache(cacheName, options);

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

./media/image1.png

  • .NET
  • Java
  • Python
  • Node.js
// Initialize credentials
string userName = string.Empty;
string password = string.Empty;
string cacheName = "demoCache";

// Check if Username and Password is provided through App.config file
if (ConfigurationManager.AppSettings["Username"] != null)
{
      userName = ConfigurationManager.AppSettings["Username"].ToString();
}
if (ConfigurationManager.AppSettings["Password"] != null)
{
      password = ConfigurationManager.AppSettings["Password"].ToString();
}

// Use CacheConnectionOptions to provide credentials
var options = new CacheConnectionOptions();

options.UserCredentials = new Credentials(userName, password);

// Connect to cache with security credentials provided in App.config file
ICache cache = CacheManager.GetCache(cacheName, options);
String cacheName = "demoCache";

// Use CacheConnectionOptions to provide credentials
CacheConnectionOptions options = new CacheConnectionOptions();

Properties properties = new Properties();
properties.loadFromXML(new FileInputStream("src/main/resources/security.properties"));

String userName = properties.getProperty("Username");
String password = properties.getProperty("Password");

// Use UserCredentials property to assign credentials
options.setUserCredentials(new Credentials(userName, password));

// Connecting to cache with security credentials
Cache cache = CacheManager.getCache(cacheName, options);

// Use the cache object for your operations
System.out.println("Security Enabled");
cache_name = "demoCache"

# Check if Username and password is provided in the property file of the application
user_name = config.get('User', 'UserName')
password = config.get('User', 'Password')

# Use CacheConnectionOptions to provide credentials
options = ncache.CacheConnectionOptions()
credentials = ncache.Credentials(user_name, password)
options.set_user_credentials(credentials)

# Initializing cache with security credentials provided in the property file
cache = ncache.CacheManager.get_cache(cache_name, options)
// This is an async method

let cacheName = "demoClusteredCache";

// Check if Username and password is provided in the property file of the application
let userName = properties.get('User.UserName');
let password = properties.get('User.Password');

// Use CacheConnectionOptions to provide credentials
let options = new ncache.CacheConnectionOptions();
let credentials = new ncache.Credentials(userName, password);
options.setUserCredentials(credentials);

// Initializing cache with security credentials provided in the property file
let cache = await ncache.CacheManager.getCache(cacheName, options);

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 GetCache() or Configure Security 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 a given domain in LDAP. The login credentials are required to belong to any server hosting the user login and running LDAP services.

See Also

NCache Data Encryption
Stream Processing in Cache
Configuring Security

In This Article
  • Prerequisites
  • Troubleshooting
    • Alachisoft.NCache.Runtime.Exceptions.SecurityException
  • See Also

Contact Us

PHONE

+1 (214) 764-6933   (US)

+44 20 7993 8327   (UK)

 
EMAIL

sales@alachisoft.com

support@alachisoft.com

NCache
  • NCache Enterprise
  • NCache Professional
  • Edition Comparison
  • NCache Architecture
  • Benchmarks
Download
Pricing
Try Playground

Deployments
  • Cloud (SaaS & Software)
  • On-Premises
  • Kubernetes
  • Docker
Technical Use Cases
  • ASP.NET Sessions
  • ASP.NET Core Sessions
  • Pub/Sub Messaging
  • Real-Time ASP.NET SignalR
  • Internet of Things (IoT)
  • NoSQL Database
  • Stream Processing
  • Microservices
Resources
  • Magazine Articles
  • Third-Party Articles
  • Articles
  • Videos
  • Whitepapers
  • Shows
  • Talks
  • Blogs
  • Docs
Customer Case Studies
  • Testimonials
  • Customers
Support
  • Schedule a Demo
  • Forum (Google Groups)
  • Tips
Company
  • Leadership
  • Partners
  • News
  • Events
  • Careers
Contact Us

  • EnglishChinese (Simplified)FrenchGermanItalianJapaneseKoreanPortugueseSpanish

  • Contact Us
  •  
  • Sitemap
  •  
  • Terms of Use
  •  
  • Privacy Policy
© Copyright Alachisoft 2002 - 2025. All rights reserved. NCache is a registered trademark of Diyatech Corp.
Back to top