Startup¶
IdentityServer is a combination of middleware and services. All configuration is done in your startup class.
Configuring services¶
You add the IdentityServer services to the DI system by calling:
public void ConfigureServices(IServiceCollection services)
{
var builder = services.AddIdentityServer();
}
Optionally you can pass in options into this call. See here for details on options.
This will return you a builder object that in turn has a number of convenience methods to wire up additional services.
Key material¶
AddSigningCredential
- Adds a signing key service that provides the specified key material to the various token creation/validation services.
You can pass in either an
X509Certificate2
, aSigningCredential
or a reference to a certificate from the certificate store.
AddDeveloperSigningCredential
- Creates temporary key material at startup time. This is for dev only scenarios when you don’t have a certificate to use.
The generated key will be persisted to the file system so it stays stable between server restarts (can be disabled by passing
false
). This addresses issues when the client/api metadata caches get out of sync during development.
AddValidationKey
- Adds a key for validating tokens. They will be used by the internal token validator and will show up in the discovery document.
You can pass in either an
X509Certificate2
, aSigningCredential
or a reference to a certificate from the certificate store. This is useful for key roll-over scenarios.
In-Memory configuration stores¶
The various “in-memory” configuration APIs allow for configuring IdentityServer from an in-memory list of 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.
AddInMemoryClients
- Registers
IClientStore
andICorsPolicyService
implementations based on the in-memory collection ofClient
configuration objects.
AddInMemoryIdentityResources
- Registers
IResourceStore
implementation based on the in-memory collection ofIdentityResource
configuration objects.
AddInMemoryApiResources
- Registers
IResourceStore
implementation based on the in-memory collection ofApiResource
configuration objects.
Test stores¶
The TestUser
class models a user, their credentials, and claims in IdentityServer.
Use of TestUser
is simiar to the use of the “in-memory” stores in that it is intended for when prototyping, developing, and/or testing.
The use of TestUser
is not recommended in production.
AddTestUsers
- Registers
TestUserStore
based on a collection ofTestUser
objects.TestUserStore
is used by the default quickstart UI. Also registers implementations ofIProfileService
andIResourceOwnerPasswordValidator
.
Additional services¶
AddExtensionGrantValidator
- Adds
IExtensionGrantValidator
implementation for use with extension grants.
AddSecretParser
- Adds
ISecretParser
implementation for parsing client or API resource credentials.
AddSecretValidator
- Adds
ISecretValidator
implementation for validating client or API resource credentials against a credential store.
AddResourceOwnerValidator
- Adds
IResourceOwnerPasswordValidator
implementation for validating user credentials for the resource owner password credentials grant type.
AddProfileService
- Adds
IProfileService
implementation for connecting to your custom user profile store. TheDefaultProfileService
class provides the default implementation which relies upon the authentication cookie as the only source of claims for issuing in tokens.
AddAuthorizeInteractionResponseGenerator
- Adds
IAuthorizeInteractionResponseGenerator
implementation to customize logic at authorization endpoint for when a user must be shown a UI for error, login, consent, or any other custom page. TheAuthorizeInteractionResponseGenerator
class provides a default implementation, so consider deriving from this existing class if you need to augment the existing behavior.
AddCustomAuthorizeRequestValidator
- Adds
ICustomAuthorizeRequestValidator
implementation to customize request parameter validation at the authorization endpoint.
AddCustomTokenRequestValidator
- Adds
ICustomTokenRequestValidator
implementation to customize request parameter validation at the token endpoint.
AddRedirectUriValidator
- Adds
IRedirectUriValidator
implementation to customize redirect URI validation.
AddAppAuthRedirectUriValidator
- Adds a an “AppAuth” (OAuth 2.0 for Native Apps) compliant redirect URI validator (does strict validation but also allows http://127.0.0.1 with random port).
AddJwtBearerClientAuthentication
- Adds support for client authentication using JWT bearer assertions.
Caching¶
Client and resource configuration data is used frequently by IdentityServer. If this data is being loaded from a database or other external store, then it might be expensive to frequently re-load the same data.
AddInMemoryCaching
- To use any of the caches described below, an implementation of
ICache<T>
must be registered in DI. This API registers a default in-memory implementation ofICache<T>
that’s based on ASP.NET Core’sMemoryCache
.
AddClientStoreCache
- Registers a
IClientStore
decorator implementation which will maintain an in-memory cache ofClient
configuration objects. The cache duration is configurable on theCaching
configuration options on theIdentityServerOptions
.
AddResourceStoreCache
- Registers a
IResourceStore
decorator implementation which will maintain an in-memory cache ofIdentityResource
andApiResource
configuration objects. The cache duration is configurable on theCaching
configuration options on theIdentityServerOptions
.
AddCorsPolicyCache
- Registers a
ICorsPolicyService
decorator implementation which will maintain an in-memory cache of the results of the CORS policy service evaluation. The cache duration is configurable on theCaching
configuration options on theIdentityServerOptions
.
Further customization of the cache is possible:
The default caching relies upon the ICache<T>
implementation.
If you wish to customize the caching behavior for the specific configuration objects, you can replace this implementation in the dependency injection system.
The default implementation of the ICache<T>
itself relies upon the IMemoryCache
interface (and MemoryCache
implementation) provided by .NET.
If you wish to customize the in-memory caching behavior, you can replace the IMemoryCache
implementation in the dependency injection system.
Configuring the pipeline¶
You need to add IdentityServer to the pipeline by calling:
public void Configure(IApplicationBuilder app)
{
app.UseIdentityServer();
}
Note
UseIdentityServer
includes a call to UseAuthentication
, so it’s not necessary to have both.
There is no additional configuration for the middleware.
Be aware that order matters in the pipeline. For example, you will want to add IdentitySever before the UI framework that implements the login screen.