From 321ab58801b566400fa9de64e5403f065f1585e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Chalet?= Date: Sat, 2 Jun 2018 22:56:17 +0200 Subject: [PATCH] Rename OpenIddictEntityFrameworkCoreOptions/OpenIddictEntityFrameworkOptions.ContextType to DbContextType --- .../Resolvers/OpenIddictApplicationStoreResolver.cs | 2 +- .../Resolvers/OpenIddictAuthorizationStoreResolver.cs | 2 +- .../Resolvers/OpenIddictScopeStoreResolver.cs | 2 +- .../Resolvers/OpenIddictTokenStoreResolver.cs | 2 +- .../OpenIddictEntityFrameworkBuilder.cs | 2 +- .../OpenIddictEntityFrameworkOptions.cs | 2 +- .../Resolvers/OpenIddictApplicationStoreResolver.cs | 2 +- .../Resolvers/OpenIddictAuthorizationStoreResolver.cs | 2 +- .../Resolvers/OpenIddictScopeStoreResolver.cs | 2 +- .../Resolvers/OpenIddictTokenStoreResolver.cs | 2 +- .../OpenIddictEntityFrameworkCoreBuilder.cs | 2 +- .../OpenIddictEntityFrameworkCoreOptions.cs | 2 +- .../Resolvers/OpenIddictApplicationStoreResolver.cs | 2 +- .../Resolvers/OpenIddictAuthorizationStoreResolver.cs | 2 +- .../Resolvers/OpenIddictScopeStoreResolver.cs | 2 +- .../Resolvers/OpenIddictTokenStoreResolver.cs | 2 +- src/OpenIddict.Server/OpenIddictServerBuilder.cs | 7 +++---- src/OpenIddict.Validation/OpenIddict.Validation.csproj | 1 - .../OpenIddictValidationExtensions.cs | 6 ++++++ 19 files changed, 25 insertions(+), 21 deletions(-) diff --git a/src/OpenIddict.Core/Resolvers/OpenIddictApplicationStoreResolver.cs b/src/OpenIddict.Core/Resolvers/OpenIddictApplicationStoreResolver.cs index 41353685..5913dd68 100644 --- a/src/OpenIddict.Core/Resolvers/OpenIddictApplicationStoreResolver.cs +++ b/src/OpenIddict.Core/Resolvers/OpenIddictApplicationStoreResolver.cs @@ -32,7 +32,7 @@ namespace OpenIddict.Core throw new InvalidOperationException(new StringBuilder() .AppendLine("No application store has been registered in the dependency injection container.") .Append("To register the Entity Framework Core stores, reference the 'OpenIddict.EntityFrameworkCore' ") - .AppendLine("package and call 'services.AddOpenIddict().AddCore().AddEntityFrameworkCoreStores()'.") + .AppendLine("package and call 'services.AddOpenIddict().AddCore().UseEntityFrameworkCore()'.") .Append("To register a custom store, create an implementation of 'IOpenIddictApplicationStore' and ") .Append("use 'services.AddOpenIddict().AddCore().AddApplicationStore()' to add it to the DI container.") .ToString()); diff --git a/src/OpenIddict.Core/Resolvers/OpenIddictAuthorizationStoreResolver.cs b/src/OpenIddict.Core/Resolvers/OpenIddictAuthorizationStoreResolver.cs index 051ac7d5..e520a8eb 100644 --- a/src/OpenIddict.Core/Resolvers/OpenIddictAuthorizationStoreResolver.cs +++ b/src/OpenIddict.Core/Resolvers/OpenIddictAuthorizationStoreResolver.cs @@ -32,7 +32,7 @@ namespace OpenIddict.Core throw new InvalidOperationException(new StringBuilder() .AppendLine("No authorization store has been registered in the dependency injection container.") .Append("To register the Entity Framework Core stores, reference the 'OpenIddict.EntityFrameworkCore' ") - .AppendLine("package and call 'services.AddOpenIddict().AddCore().AddEntityFrameworkCoreStores()'.") + .AppendLine("package and call 'services.AddOpenIddict().AddCore().UseEntityFrameworkCore()'.") .Append("To register a custom store, create an implementation of 'IOpenIddictAuthorizationStore' and ") .Append("use 'services.AddOpenIddict().AddCore().AddAuthorizationStore()' to add it to the DI container.") .ToString()); diff --git a/src/OpenIddict.Core/Resolvers/OpenIddictScopeStoreResolver.cs b/src/OpenIddict.Core/Resolvers/OpenIddictScopeStoreResolver.cs index 622ba7ff..f40777b0 100644 --- a/src/OpenIddict.Core/Resolvers/OpenIddictScopeStoreResolver.cs +++ b/src/OpenIddict.Core/Resolvers/OpenIddictScopeStoreResolver.cs @@ -32,7 +32,7 @@ namespace OpenIddict.Core throw new InvalidOperationException(new StringBuilder() .AppendLine("No scope store has been registered in the dependency injection container.") .Append("To register the Entity Framework Core stores, reference the 'OpenIddict.EntityFrameworkCore' ") - .AppendLine("package and call 'services.AddOpenIddict().AddCore().AddEntityFrameworkCoreStores()'.") + .AppendLine("package and call 'services.AddOpenIddict().AddCore().UseEntityFrameworkCore()'.") .Append("To register a custom store, create an implementation of 'IOpenIddictScopeStore' and ") .Append("use 'services.AddOpenIddict().AddCore().AddScopeStore()' to add it to the DI container.") .ToString()); diff --git a/src/OpenIddict.Core/Resolvers/OpenIddictTokenStoreResolver.cs b/src/OpenIddict.Core/Resolvers/OpenIddictTokenStoreResolver.cs index c79152cc..48f7a11b 100644 --- a/src/OpenIddict.Core/Resolvers/OpenIddictTokenStoreResolver.cs +++ b/src/OpenIddict.Core/Resolvers/OpenIddictTokenStoreResolver.cs @@ -32,7 +32,7 @@ namespace OpenIddict.Core throw new InvalidOperationException(new StringBuilder() .AppendLine("No token store factory has been registered in the dependency injection container.") .Append("To register the Entity Framework Core stores, reference the 'OpenIddict.EntityFrameworkCore' ") - .AppendLine("package and call 'services.AddOpenIddict().AddCore().AddEntityFrameworkCoreStores()'.") + .AppendLine("package and call 'services.AddOpenIddict().AddCore().UseEntityFrameworkCore()'.") .Append("To register a custom store, create an implementation of 'IOpenIddictTokenStore' and ") .Append("use 'services.AddOpenIddict().AddCore().AddTokenStore()' to add it to the DI container.") .ToString()); diff --git a/src/OpenIddict.EntityFramework/OpenIddictEntityFrameworkBuilder.cs b/src/OpenIddict.EntityFramework/OpenIddictEntityFrameworkBuilder.cs index 6558f6af..202a2a2c 100644 --- a/src/OpenIddict.EntityFramework/OpenIddictEntityFrameworkBuilder.cs +++ b/src/OpenIddict.EntityFramework/OpenIddictEntityFrameworkBuilder.cs @@ -82,7 +82,7 @@ namespace Microsoft.Extensions.DependencyInjection throw new ArgumentException("The specified type is invalid.", nameof(type)); } - return Configure(options => options.ContextType = type); + return Configure(options => options.DbContextType = type); } /// diff --git a/src/OpenIddict.EntityFramework/OpenIddictEntityFrameworkOptions.cs b/src/OpenIddict.EntityFramework/OpenIddictEntityFrameworkOptions.cs index 058e9f2d..9e563f8f 100644 --- a/src/OpenIddict.EntityFramework/OpenIddictEntityFrameworkOptions.cs +++ b/src/OpenIddict.EntityFramework/OpenIddictEntityFrameworkOptions.cs @@ -20,6 +20,6 @@ namespace OpenIddict.EntityFramework /// OpenIddict Entity Framework 6.x stores. If this property is not populated, /// an exception is thrown at runtime when trying to use the stores. /// - public Type ContextType { get; set; } + public Type DbContextType { get; set; } } } diff --git a/src/OpenIddict.EntityFramework/Resolvers/OpenIddictApplicationStoreResolver.cs b/src/OpenIddict.EntityFramework/Resolvers/OpenIddictApplicationStoreResolver.cs index 6882ba5f..73a0e076 100644 --- a/src/OpenIddict.EntityFramework/Resolvers/OpenIddictApplicationStoreResolver.cs +++ b/src/OpenIddict.EntityFramework/Resolvers/OpenIddictApplicationStoreResolver.cs @@ -60,7 +60,7 @@ namespace OpenIddict.EntityFramework .ToString()); } - var context = _options.CurrentValue.ContextType; + var context = _options.CurrentValue.DbContextType; if (context == null) { throw new InvalidOperationException(new StringBuilder() diff --git a/src/OpenIddict.EntityFramework/Resolvers/OpenIddictAuthorizationStoreResolver.cs b/src/OpenIddict.EntityFramework/Resolvers/OpenIddictAuthorizationStoreResolver.cs index a67be50d..79219a0d 100644 --- a/src/OpenIddict.EntityFramework/Resolvers/OpenIddictAuthorizationStoreResolver.cs +++ b/src/OpenIddict.EntityFramework/Resolvers/OpenIddictAuthorizationStoreResolver.cs @@ -60,7 +60,7 @@ namespace OpenIddict.EntityFramework .ToString()); } - var context = _options.CurrentValue.ContextType; + var context = _options.CurrentValue.DbContextType; if (context == null) { throw new InvalidOperationException(new StringBuilder() diff --git a/src/OpenIddict.EntityFramework/Resolvers/OpenIddictScopeStoreResolver.cs b/src/OpenIddict.EntityFramework/Resolvers/OpenIddictScopeStoreResolver.cs index a61dc28f..33e4e5c9 100644 --- a/src/OpenIddict.EntityFramework/Resolvers/OpenIddictScopeStoreResolver.cs +++ b/src/OpenIddict.EntityFramework/Resolvers/OpenIddictScopeStoreResolver.cs @@ -60,7 +60,7 @@ namespace OpenIddict.EntityFramework .ToString()); } - var context = _options.CurrentValue.ContextType; + var context = _options.CurrentValue.DbContextType; if (context == null) { throw new InvalidOperationException(new StringBuilder() diff --git a/src/OpenIddict.EntityFramework/Resolvers/OpenIddictTokenStoreResolver.cs b/src/OpenIddict.EntityFramework/Resolvers/OpenIddictTokenStoreResolver.cs index 2b17d637..7d020653 100644 --- a/src/OpenIddict.EntityFramework/Resolvers/OpenIddictTokenStoreResolver.cs +++ b/src/OpenIddict.EntityFramework/Resolvers/OpenIddictTokenStoreResolver.cs @@ -60,7 +60,7 @@ namespace OpenIddict.EntityFramework .ToString()); } - var context = _options.CurrentValue.ContextType; + var context = _options.CurrentValue.DbContextType; if (context == null) { throw new InvalidOperationException(new StringBuilder() diff --git a/src/OpenIddict.EntityFrameworkCore/OpenIddictEntityFrameworkCoreBuilder.cs b/src/OpenIddict.EntityFrameworkCore/OpenIddictEntityFrameworkCoreBuilder.cs index 4e291063..5bd9ff63 100644 --- a/src/OpenIddict.EntityFrameworkCore/OpenIddictEntityFrameworkCoreBuilder.cs +++ b/src/OpenIddict.EntityFrameworkCore/OpenIddictEntityFrameworkCoreBuilder.cs @@ -82,7 +82,7 @@ namespace Microsoft.Extensions.DependencyInjection throw new ArgumentException("The specified type is invalid.", nameof(type)); } - return Configure(options => options.ContextType = type); + return Configure(options => options.DbContextType = type); } /// diff --git a/src/OpenIddict.EntityFrameworkCore/OpenIddictEntityFrameworkCoreOptions.cs b/src/OpenIddict.EntityFrameworkCore/OpenIddictEntityFrameworkCoreOptions.cs index e27f0227..47a9efc0 100644 --- a/src/OpenIddict.EntityFrameworkCore/OpenIddictEntityFrameworkCoreOptions.cs +++ b/src/OpenIddict.EntityFrameworkCore/OpenIddictEntityFrameworkCoreOptions.cs @@ -20,6 +20,6 @@ namespace OpenIddict.EntityFrameworkCore /// OpenIddict Entity Framework Core stores. If this property is not populated, /// an exception is thrown at runtime when trying to use the stores. /// - public Type ContextType { get; set; } + public Type DbContextType { get; set; } } } diff --git a/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictApplicationStoreResolver.cs b/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictApplicationStoreResolver.cs index c9398954..1c650014 100644 --- a/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictApplicationStoreResolver.cs +++ b/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictApplicationStoreResolver.cs @@ -60,7 +60,7 @@ namespace OpenIddict.EntityFrameworkCore .ToString()); } - var context = _options.CurrentValue.ContextType; + var context = _options.CurrentValue.DbContextType; if (context == null) { throw new InvalidOperationException(new StringBuilder() diff --git a/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictAuthorizationStoreResolver.cs b/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictAuthorizationStoreResolver.cs index 4335f3ac..3d6c1fc8 100644 --- a/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictAuthorizationStoreResolver.cs +++ b/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictAuthorizationStoreResolver.cs @@ -61,7 +61,7 @@ namespace OpenIddict.EntityFrameworkCore .ToString()); } - var context = _options.CurrentValue.ContextType; + var context = _options.CurrentValue.DbContextType; if (context == null) { throw new InvalidOperationException(new StringBuilder() diff --git a/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictScopeStoreResolver.cs b/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictScopeStoreResolver.cs index 1493ff46..f847ea29 100644 --- a/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictScopeStoreResolver.cs +++ b/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictScopeStoreResolver.cs @@ -60,7 +60,7 @@ namespace OpenIddict.EntityFrameworkCore .ToString()); } - var context = _options.CurrentValue.ContextType; + var context = _options.CurrentValue.DbContextType; if (context == null) { throw new InvalidOperationException(new StringBuilder() diff --git a/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictTokenStoreResolver.cs b/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictTokenStoreResolver.cs index 1223ac56..e009bee8 100644 --- a/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictTokenStoreResolver.cs +++ b/src/OpenIddict.EntityFrameworkCore/Resolvers/OpenIddictTokenStoreResolver.cs @@ -60,7 +60,7 @@ namespace OpenIddict.EntityFrameworkCore .ToString()); } - var context = _options.CurrentValue.ContextType; + var context = _options.CurrentValue.DbContextType; if (context == null) { throw new InvalidOperationException(new StringBuilder() diff --git a/src/OpenIddict.Server/OpenIddictServerBuilder.cs b/src/OpenIddict.Server/OpenIddictServerBuilder.cs index 86ad1ba9..0d3e381a 100644 --- a/src/OpenIddict.Server/OpenIddictServerBuilder.cs +++ b/src/OpenIddict.Server/OpenIddictServerBuilder.cs @@ -559,8 +559,6 @@ namespace Microsoft.Extensions.DependencyInjection throw new ArgumentException("The specified type is invalid.", nameof(type)); } - // Note: the OIDC server provider is resolved per-request and thus - // should be registered either as a scoped or transient service. Services.TryAddScoped(type); return Configure(options => options.ApplicationProviderType = type); @@ -671,8 +669,9 @@ namespace Microsoft.Extensions.DependencyInjection } /// - /// Sets JWT as the default token format for access tokens. - /// Note: this option cannot be used when using reference tokens. + /// Sets JSON Web Token (JWT) as the default token format for access tokens. + /// Note: JWT tokens cannot be used with the OpenIddict validation handler. + /// To validate JWT tokens, use the JWT handler shipping with ASP.NET Core. /// /// The . public OpenIddictServerBuilder UseJsonWebTokens() diff --git a/src/OpenIddict.Validation/OpenIddict.Validation.csproj b/src/OpenIddict.Validation/OpenIddict.Validation.csproj index 8be61717..5628ec8b 100644 --- a/src/OpenIddict.Validation/OpenIddict.Validation.csproj +++ b/src/OpenIddict.Validation/OpenIddict.Validation.csproj @@ -19,7 +19,6 @@ - diff --git a/src/OpenIddict.Validation/OpenIddictValidationExtensions.cs b/src/OpenIddict.Validation/OpenIddictValidationExtensions.cs index b983bbf1..c0b8ee95 100644 --- a/src/OpenIddict.Validation/OpenIddictValidationExtensions.cs +++ b/src/OpenIddict.Validation/OpenIddictValidationExtensions.cs @@ -18,6 +18,9 @@ namespace Microsoft.Extensions.DependencyInjection { /// /// Registers the OpenIddict token validation services in the DI container. + /// Note: the validation handler only works with the default token format + /// or reference tokens and cannot be used with JWT tokens. To validate + /// JWT tokens, use the JWT bearer handler shipping with ASP.NET Core. /// /// The services builder used by OpenIddict to register new services. /// This extension can be safely called multiple times. @@ -63,6 +66,9 @@ namespace Microsoft.Extensions.DependencyInjection /// /// Registers the OpenIddict token validation services in the DI container. + /// Note: the validation handler only works with the default token format + /// or reference tokens and cannot be used with JWT tokens. To validate + /// JWT tokens, use the JWT bearer handler shipping with ASP.NET Core. /// /// The services builder used by OpenIddict to register new services. /// The configuration delegate used to configure the validation services.