Configuration Data
Configuration data models the information for Clients and Resources.
Stores
Section titled “Stores”Store interfaces are designed to abstract accessing the configuration data. The stores used in Duende IdentityServer are:
- Client store for
Client
data. - CORS policy service
for CORS support. Given that this is so closely tied to the
Client
configuration data, the CORS policy service is considered one of the configuration stores. - Resource store for
IdentityResource
,ApiResource
, andApiScope
data. - Identity Provider store for
IdentityProvider
data.
Registering Custom Stores
Section titled “Registering Custom Stores”Custom implementations of the stores must be registered in the ASP.NET Core service provider. There are convenience methods for registering these. For example:
builder.Services.AddIdentityServer() .AddClientStore<YourCustomClientStore>() .AddCorsPolicyService<YourCustomCorsPolicyService>() .AddResourceStore<YourCustomResourceStore>() .AddIdentityProviderStore<YourCustomAddIdentityProviderStore>();
Caching Configuration Data
Section titled “Caching Configuration Data”Configuration data is used frequently during request processing. If this data is loaded from a database or other external store, then it might be expensive to frequently re-load the same data.
Duende IdentityServer provides convenience methods to
enable caching data from the various stores.
The caching implementation relies upon an ICache<T>
service and must also be added to the ASP.NET Core service provider.
For example:
builder.Services.AddIdentityServer() .AddClientStore<YourCustomClientStore>() .AddCorsPolicyService<YourCustomCorsPolicyService>() .AddResourceStore<YourCustomResourceStore>() .AddInMemoryCaching() .AddClientStoreCache<YourCustomClientStore>() .AddCorsPolicyCache<YourCustomCorsPolicyService>() .AddResourceStoreCache<YourCustomResourceStore>() .AddIdentityProviderStoreCache<YourCustomAddIdentityProviderStore>();
The duration of the data in the default cache is configurable on the IdentityServerOptions. For example:
builder.Services.AddIdentityServer(options => { options.Caching.ClientStoreExpiration = TimeSpan.FromMinutes(5); options.Caching.ResourceStoreExpiration = TimeSpan.FromMinutes(5);}) .AddClientStore<YourCustomClientStore>() .AddCorsPolicyService<YourCustomCorsPolicyService>() .AddResourceStore<YourCustomResourceStore>() .AddInMemoryCaching() .AddClientStoreCache<YourCustomClientStore>() .AddCorsPolicyCache<YourCustomCorsPolicyService>() .AddResourceStoreCache<YourCustomResourceStore>();
Further customization of the cache is possible:
- If you wish to customize the caching behavior for the specific configuration objects, you can replace the
ICache<T>
service implementation in the dependency injection system. - The default implementation of the
ICache<T>
itself relies upon theIMemoryCache
interface (andMemoryCache
implementation) provided by .NET. If you wish to customize the in-memory caching behavior, you can replace theIMemoryCache
implementation in the dependency injection system.
In-Memory Stores
Section titled “In-Memory Stores”The various in-memory configuration APIs allow for configuring IdentityServer from an in-memory list of the various configuration objects. These in-memory collections can be hard-coded in the hosting application, or could be loaded dynamically from a configuration file or a database. By design, though, these collections are only created when the hosting application is starting up.
Use of these configuration APIs are designed for use when prototyping, developing, and/or testing where it is not necessary to dynamically consult database at runtime for the configuration data. This style of configuration might also be appropriate for production scenarios if the configuration rarely changes, or it is not inconvenient to require restarting the application if the value must be changed.