AspNetCore.DataProtection.NCache 5.3.7

AspNetCore.DataProtection.NCache

NCache Key Storage Provider for the ASP.NET Core Data Protection system. This package lets you persist Data Protection keys in NCache instead of the local file system, enabling key sharing across multiple server instances in a web farm — so cookies, tokens, and other protected payloads remain valid regardless of which server handles the request.

Installation

Install-Package AspNetCore.DataProtection.NCache

or, using the .NET CLI:

dotnet add package AspNetCore.DataProtection.NCache

What is Installed

Installing this package adds the following NCache configuration files to your project:

• client.ncconf — Defines the cache client settings, including the cache name and the list of server nodes the client connects to.
• config.ncconf — Contains the cache configuration (cache topology, partitions, eviction policy, etc.) used when the cache is created/registered.
• tls.ncconf — Contains TLS/SSL settings used to secure communication between the client and the NCache cluster, if enabled.

Prerequisites

• .NET 6.0+ Application.
• NCache SDK 5.3.7.1 or later.
• An NCache 5.3.7 (or later) server should be up and running, with the target cache already created/registered on it.

Getting Started

Setting up NCache

Before running your application (if NCache is not installed on the current machine), you need to update client.ncconf so the client knows which cache to connect to and where to find it:

1. Open client.ncconf.
2. Locate the cache entry named myCache and rename it to the name of your actual cache (the cache you created/registered on the NCache server).
3. Under the server settings, update the server address to point to one of the nodes in the cluster where that cache is running.

Example:

<cache id="myCache" ... >
  <server name="10.0.0.1" ... />
</cache>

Change myCache → YourCacheName, and 10.0.0.1 → the IP/hostname of a node hosting YourCacheName.

Setting up Package

Register NCache as the Data Protection key storage provider in Program.cs:

var builder = WebApplication.CreateBuilder(args);

// Read NCache settings from appsettings.json
var cacheName = builder.Configuration["NCacheSettings:CacheName"] ?? "demoCache";
var appId = builder.Configuration["NCacheSettings:ApplicationId"] ?? "NCacheDataProtectionSample";
var keyName = builder.Configuration["NCacheSettings:KeyName"] ?? "DataProtection-Keys";

builder.Services.AddDataProtection()
    .SetApplicationName(appId)
    .PersistKeysToNCache(cacheName, keyName);

var app = builder.Build();

app.Run();

Configuration

ASP.NET Core (appsettings.json):

{
  "NCacheSettings": {
    "CacheName": "YourCacheName",
    "ApplicationId": "NCacheDataProtectionSample",
    "KeyName": "DataProtection-Keys"
  }
}

Adjust cache name and other settings as needed for your environment.

Resources

• NCache Integration Docs
• Client SDK Docs
• Sample Code on GitHub
• Programmer's Guide

Technical Support

Alachisoft provides various technical support resources.

Visit the Alachisoft Support Center to select a support resource appropriate for your issue. To request additional features or report a documentation discrepancy, contact support@alachisoft.com.

License

Copyright © 2026 Alachisoft. All rights reserved.