tsai
/
openiddict-core
mirror of https://github.com/openiddict/openiddict-core.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Rename the OpenIddictClientService.GetClientRegistrationAsync()/GetServerConfigurationAsync() APIs to be more specific and allow them to be overridden

pull/1933/head
Kévin Chalet 2 years ago
parent
c8f7c2c5bb
commit
1f91321033
4 changed files with 68 additions and 56 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      sandbox/OpenIddict.Sandbox.Console.Client/InteractiveService.cs
  2. 18
      src/OpenIddict.Client/OpenIddictClientHandlers.cs
  3. 99
      src/OpenIddict.Client/OpenIddictClientService.cs
  4. 5
      src/OpenIddict.Validation/OpenIddictValidationService.cs

2
sandbox/OpenIddict.Sandbox.Console.Client/InteractiveService.cs
View File

@ -44,7 +44,7 @@ public class InteractiveService : BackgroundService
// Resolve the server configuration and determine the type of flow // Resolve the server configuration and determine the type of flow
// to use depending on the supported grants and the user selection. // to use depending on the supported grants and the user selection.
var configuration = await _service.GetServerConfigurationAsync(provider, stoppingToken); var configuration = await _service.GetServerConfigurationByProviderNameAsync(provider, stoppingToken);
if (configuration.GrantTypesSupported.Contains(GrantTypes.DeviceCode) && if (configuration.GrantTypesSupported.Contains(GrantTypes.DeviceCode) &&
configuration.DeviceAuthorizationEndpoint is not null && configuration.DeviceAuthorizationEndpoint is not null &&
await UseDeviceAuthorizationGrantAsync(stoppingToken)) await UseDeviceAuthorizationGrantAsync(stoppingToken))

18
src/OpenIddict.Client/OpenIddictClientHandlers.cs
View File

@ -392,11 +392,11 @@ public static partial class OpenIddictClientHandlers
=> await _service.GetClientRegistrationByIdAsync(identifier, context.CancellationToken), => await _service.GetClientRegistrationByIdAsync(identifier, context.CancellationToken),
// If specified, resolve the registration using the attached issuer URI. // If specified, resolve the registration using the attached issuer URI.
{ Issuer: Uri issuer } => await _service.GetClientRegistrationAsync(issuer, context.CancellationToken), { Issuer: Uri uri } => await _service.GetClientRegistrationByIssuerAsync(uri, context.CancellationToken),
// If specified, resolve the registration using the attached provider name. // If specified, resolve the registration using the attached provider name.
{ ProviderName: string provider } when !string.IsNullOrEmpty(provider) { ProviderName: string name } when !string.IsNullOrEmpty(name)
=> await _service.GetClientRegistrationAsync(provider, context.CancellationToken), => await _service.GetClientRegistrationByProviderNameAsync(name, context.CancellationToken),
// Otherwise, default to the unique registration available, if possible. // Otherwise, default to the unique registration available, if possible.
{ Options.Registrations: [OpenIddictClientRegistration registration] } => registration, { Options.Registrations: [OpenIddictClientRegistration registration] } => registration,
@ -4195,11 +4195,11 @@ public static partial class OpenIddictClientHandlers
=> await _service.GetClientRegistrationByIdAsync(identifier, context.CancellationToken), => await _service.GetClientRegistrationByIdAsync(identifier, context.CancellationToken),
// If specified, resolve the registration using the attached issuer URI. // If specified, resolve the registration using the attached issuer URI.
{ Issuer: Uri issuer } => await _service.GetClientRegistrationAsync(issuer, context.CancellationToken), { Issuer: Uri uri } => await _service.GetClientRegistrationByIssuerAsync(uri, context.CancellationToken),
// If specified, resolve the registration using the attached provider name. // If specified, resolve the registration using the attached provider name.
{ ProviderName: string provider } when !string.IsNullOrEmpty(provider) { ProviderName: string name } when !string.IsNullOrEmpty(name)
=> await _service.GetClientRegistrationAsync(provider, context.CancellationToken), => await _service.GetClientRegistrationByProviderNameAsync(name, context.CancellationToken),
// Otherwise, default to the unique registration available, if possible. // Otherwise, default to the unique registration available, if possible.
{ Options.Registrations: [OpenIddictClientRegistration registration] } => registration, { Options.Registrations: [OpenIddictClientRegistration registration] } => registration,
@ -5846,11 +5846,11 @@ public static partial class OpenIddictClientHandlers
=> await _service.GetClientRegistrationByIdAsync(identifier, context.CancellationToken), => await _service.GetClientRegistrationByIdAsync(identifier, context.CancellationToken),
// If specified, resolve the registration using the attached issuer URI. // If specified, resolve the registration using the attached issuer URI.
{ Issuer: Uri issuer } => await _service.GetClientRegistrationAsync(issuer, context.CancellationToken), { Issuer: Uri uri } => await _service.GetClientRegistrationByIssuerAsync(uri, context.CancellationToken),
// If specified, resolve the registration using the attached provider name. // If specified, resolve the registration using the attached provider name.
{ ProviderName: string provider } when !string.IsNullOrEmpty(provider) { ProviderName: string name } when !string.IsNullOrEmpty(name)
=> await _service.GetClientRegistrationAsync(provider, context.CancellationToken), => await _service.GetClientRegistrationByProviderNameAsync(name, context.CancellationToken),
// Otherwise, default to the unique registration available, if possible. // Otherwise, default to the unique registration available, if possible.
{ Options.Registrations: [OpenIddictClientRegistration registration] } => registration, { Options.Registrations: [OpenIddictClientRegistration registration] } => registration,

99
src/OpenIddict.Client/OpenIddictClientService.cs
View File

@ -16,7 +16,10 @@ using static OpenIddict.Client.OpenIddictClientModels;
namespace OpenIddict.Client; namespace OpenIddict.Client;
public sealed class OpenIddictClientService /// <summary>
/// Provides high-level APIs for performing various authentication operations.
/// </summary>
public class OpenIddictClientService
{ {
private readonly IServiceProvider _provider; private readonly IServiceProvider _provider;
@ -28,24 +31,24 @@ public sealed class OpenIddictClientService
=> _provider = provider ?? throw new ArgumentNullException(nameof(provider)); => _provider = provider ?? throw new ArgumentNullException(nameof(provider));
/// <summary> /// <summary>
/// Resolves the client registration associated with the specified <paramref name="issuer"/>. /// Resolves the client registration associated with the specified issuer <paramref name="uri"/>.
/// </summary> /// </summary>
/// <param name="issuer">The issuer.</param> /// <param name="uri">The issuer.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> that can be used to abort the operation.</param> /// <param name="cancellationToken">The <see cref="CancellationToken"/> that can be used to abort the operation.</param>
/// <returns>The <see cref="OpenIddictClientRegistration"/> associated with the specified <paramref name="issuer"/>.</returns> /// <returns>The <see cref="OpenIddictClientRegistration"/> associated with the specified issuer <paramref name="uri"/>.</returns>
/// <exception cref="ArgumentNullException"><paramref name="issuer"/> is <see langword="null"/>.</exception> /// <exception cref="ArgumentNullException"><paramref name="uri"/> is <see langword="null"/>.</exception>
/// <exception cref="InvalidOperationException"> /// <exception cref="InvalidOperationException">
/// No <see cref="OpenIddictClientRegistration"/> was registered with the specified <paramref name="issuer"/>. /// No <see cref="OpenIddictClientRegistration"/> was registered with the specified issuer <paramref name="uri"/>.
/// </exception> /// </exception>
/// <exception cref="InvalidOperationException"> /// <exception cref="InvalidOperationException">
/// Multiple <see cref="OpenIddictClientRegistration"/> instances share the same <paramref name="issuer"/>. /// Multiple <see cref="OpenIddictClientRegistration"/> instances share the same issuer <paramref name="uri"/>.
/// </exception> /// </exception>
public ValueTask<OpenIddictClientRegistration> GetClientRegistrationAsync( public virtual ValueTask<OpenIddictClientRegistration> GetClientRegistrationByIssuerAsync(
Uri issuer, CancellationToken cancellationToken = default) Uri uri, CancellationToken cancellationToken = default)
{ {
if (issuer is null) if (uri is null)
{ {
throw new ArgumentNullException(nameof(issuer)); throw new ArgumentNullException(nameof(uri));
} }
if (cancellationToken.IsCancellationRequested) if (cancellationToken.IsCancellationRequested)
@ -55,7 +58,7 @@ public sealed class OpenIddictClientService
var options = _provider.GetRequiredService<IOptionsMonitor<OpenIddictClientOptions>>(); var options = _provider.GetRequiredService<IOptionsMonitor<OpenIddictClientOptions>>();
return options.CurrentValue.Registrations.FindAll(registration => registration.Issuer == issuer) switch return options.CurrentValue.Registrations.FindAll(registration => registration.Issuer == uri) switch
{ {
[var registration] => new(registration), [var registration] => new(registration),
@ -68,21 +71,24 @@ public sealed class OpenIddictClientService
} }
/// <summary> /// <summary>
/// Resolves the client registration associated with the specified <paramref name="provider"/>. /// Resolves the client registration associated with the specified provider <paramref name="name"/>.
/// </summary> /// </summary>
/// <param name="provider">The provider name.</param> /// <param name="name">The provider name.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> that can be used to abort the operation.</param> /// <param name="cancellationToken">The <see cref="CancellationToken"/> that can be used to abort the operation.</param>
/// <returns>The <see cref="OpenIddictClientRegistration"/> associated with the specified <paramref name="provider"/>.</returns> /// <returns>The <see cref="OpenIddictClientRegistration"/> associated with the specified provider <paramref name="name"/>.</returns>
/// <exception cref="ArgumentNullException"><paramref name="provider"/> is <see langword="null"/>.</exception> /// <exception cref="ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
/// <exception cref="InvalidOperationException">
/// No <see cref="OpenIddictClientRegistration"/> was registered with the specified provider <paramref name="name"/>.
/// </exception>
/// <exception cref="InvalidOperationException"> /// <exception cref="InvalidOperationException">
/// No <see cref="OpenIddictClientRegistration"/> was registered with the specified <paramref name="provider"/>. /// Multiple <see cref="OpenIddictClientRegistration"/> instances share the same provider <paramref name="name"/>.
/// </exception> /// </exception>
public ValueTask<OpenIddictClientRegistration> GetClientRegistrationAsync( public virtual ValueTask<OpenIddictClientRegistration> GetClientRegistrationByProviderNameAsync(
string provider, CancellationToken cancellationToken = default) string name, CancellationToken cancellationToken = default)
{ {
if (string.IsNullOrEmpty(provider)) if (string.IsNullOrEmpty(name))
{ {
throw new ArgumentException(SR.FormatID0366(nameof(provider)), nameof(provider)); throw new ArgumentException(SR.FormatID0366(nameof(name)), nameof(name));
} }
if (cancellationToken.IsCancellationRequested) if (cancellationToken.IsCancellationRequested)
@ -93,7 +99,7 @@ public sealed class OpenIddictClientService
var options = _provider.GetRequiredService<IOptionsMonitor<OpenIddictClientOptions>>(); var options = _provider.GetRequiredService<IOptionsMonitor<OpenIddictClientOptions>>();
return options.CurrentValue.Registrations.FindAll(registration => string.Equals( return options.CurrentValue.Registrations.FindAll(registration => string.Equals(
registration.ProviderName, provider, StringComparison.Ordinal)) switch registration.ProviderName, name, StringComparison.Ordinal)) switch
{ {
[var registration] => new(registration), [var registration] => new(registration),
@ -115,7 +121,7 @@ public sealed class OpenIddictClientService
/// <exception cref="InvalidOperationException"> /// <exception cref="InvalidOperationException">
/// No <see cref="OpenIddictClientRegistration"/> was registered with the specified <paramref name="identifier"/>. /// No <see cref="OpenIddictClientRegistration"/> was registered with the specified <paramref name="identifier"/>.
/// </exception> /// </exception>
public ValueTask<OpenIddictClientRegistration> GetClientRegistrationByIdAsync( public virtual ValueTask<OpenIddictClientRegistration> GetClientRegistrationByIdAsync(
string identifier, CancellationToken cancellationToken = default) string identifier, CancellationToken cancellationToken = default)
{ {
if (string.IsNullOrEmpty(identifier)) if (string.IsNullOrEmpty(identifier))
@ -136,24 +142,27 @@ public sealed class OpenIddictClientService
} }
/// <summary> /// <summary>
/// Resolves the server configuration associated with the specified <paramref name="issuer"/>. /// Resolves the server configuration associated with the specified issuer <paramref name="uri"/>.
/// </summary> /// </summary>
/// <param name="issuer">The issuer.</param> /// <param name="uri">The issuer.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> that can be used to abort the operation.</param> /// <param name="cancellationToken">The <see cref="CancellationToken"/> that can be used to abort the operation.</param>
/// <returns>The <see cref="OpenIddictConfiguration"/> associated with the specified <paramref name="issuer"/>.</returns> /// <returns>The <see cref="OpenIddictConfiguration"/> associated with the specified issuer <paramref name="uri"/>.</returns>
/// <exception cref="ArgumentNullException"><paramref name="issuer"/> is <see langword="null"/>.</exception> /// <exception cref="ArgumentNullException"><paramref name="uri"/> is <see langword="null"/>.</exception>
/// <exception cref="InvalidOperationException"> /// <exception cref="InvalidOperationException">
/// No <see cref="OpenIddictClientRegistration"/> was registered with the specified <paramref name="issuer"/>. /// No <see cref="OpenIddictClientRegistration"/> was registered with the specified issuer <paramref name="uri"/>.
/// </exception> /// </exception>
public async ValueTask<OpenIddictConfiguration> GetServerConfigurationAsync( /// <exception cref="InvalidOperationException">
Uri issuer, CancellationToken cancellationToken = default) /// Multiple <see cref="OpenIddictClientRegistration"/> instances share the same issuer <paramref name="uri"/>.
/// </exception>
public virtual async ValueTask<OpenIddictConfiguration> GetServerConfigurationByIssuerAsync(
Uri uri, CancellationToken cancellationToken = default)
{ {
if (issuer is null) if (uri is null)
{ {
throw new ArgumentNullException(nameof(issuer)); throw new ArgumentNullException(nameof(uri));
} }
var registration = await GetClientRegistrationAsync(issuer, cancellationToken); var registration = await GetClientRegistrationByIssuerAsync(uri, cancellationToken);
if (registration.ConfigurationManager is null) if (registration.ConfigurationManager is null)
{ {
throw new InvalidOperationException(SR.GetResourceString(SR.ID0422)); throw new InvalidOperationException(SR.GetResourceString(SR.ID0422));
@ -166,27 +175,27 @@ public sealed class OpenIddictClientService
} }
/// <summary> /// <summary>
/// Resolves the server configuration associated with the specified <paramref name="provider"/>. /// Resolves the server configuration associated with the specified provider <paramref name="name"/>.
/// </summary> /// </summary>
/// <param name="provider">The provider name.</param> /// <param name="name">The provider name.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> that can be used to abort the operation.</param> /// <param name="cancellationToken">The <see cref="CancellationToken"/> that can be used to abort the operation.</param>
/// <returns>The <see cref="OpenIddictConfiguration"/> associated with the specified <paramref name="provider"/>.</returns> /// <returns>The <see cref="OpenIddictConfiguration"/> associated with the specified provider <paramref name="name"/>.</returns>
/// <exception cref="ArgumentNullException"><paramref name="provider"/> is <see langword="null"/>.</exception> /// <exception cref="ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
/// <exception cref="InvalidOperationException"> /// <exception cref="InvalidOperationException">
/// No <see cref="OpenIddictClientRegistration"/> was registered with the specified <paramref name="provider"/>. /// No <see cref="OpenIddictClientRegistration"/> was registered with the specified provider <paramref name="name"/>.
/// </exception> /// </exception>
/// <exception cref="InvalidOperationException"> /// <exception cref="InvalidOperationException">
/// Multiple <see cref="OpenIddictClientRegistration"/> instances share the same <paramref name="provider"/>. /// Multiple <see cref="OpenIddictClientRegistration"/> instances share the same provider <paramref name="name"/>.
/// </exception> /// </exception>
public async ValueTask<OpenIddictConfiguration> GetServerConfigurationAsync( public virtual async ValueTask<OpenIddictConfiguration> GetServerConfigurationByProviderNameAsync(
string provider, CancellationToken cancellationToken = default) string name, CancellationToken cancellationToken = default)
{ {
if (string.IsNullOrEmpty(provider)) if (string.IsNullOrEmpty(name))
{ {
throw new ArgumentException(SR.FormatID0366(nameof(provider)), nameof(provider)); throw new ArgumentException(SR.FormatID0366(nameof(name)), nameof(name));
} }
var registration = await GetClientRegistrationAsync(provider, cancellationToken); var registration = await GetClientRegistrationByProviderNameAsync(name, cancellationToken);
if (registration.ConfigurationManager is null) if (registration.ConfigurationManager is null)
{ {
throw new InvalidOperationException(SR.GetResourceString(SR.ID0422)); throw new InvalidOperationException(SR.GetResourceString(SR.ID0422));
@ -208,7 +217,7 @@ public sealed class OpenIddictClientService
/// <exception cref="InvalidOperationException"> /// <exception cref="InvalidOperationException">
/// No <see cref="OpenIddictClientRegistration"/> was registered with the specified <paramref name="identifier"/>. /// No <see cref="OpenIddictClientRegistration"/> was registered with the specified <paramref name="identifier"/>.
/// </exception> /// </exception>
public async ValueTask<OpenIddictConfiguration> GetServerConfigurationByRegistrationIdAsync( public virtual async ValueTask<OpenIddictConfiguration> GetServerConfigurationByRegistrationIdAsync(
string identifier, CancellationToken cancellationToken = default) string identifier, CancellationToken cancellationToken = default)
{ {
if (string.IsNullOrEmpty(identifier)) if (string.IsNullOrEmpty(identifier))

5
src/OpenIddict.Validation/OpenIddictValidationService.cs
View File

@ -15,7 +15,10 @@ using static OpenIddict.Abstractions.OpenIddictExceptions;
namespace OpenIddict.Validation; namespace OpenIddict.Validation;
public sealed class OpenIddictValidationService /// <summary>
/// Provides high-level APIs for performing various authentication operations.
/// </summary>
public class OpenIddictValidationService
{ {
private readonly IServiceProvider _provider; private readonly IServiceProvider _provider;

Write Preview
Loading…
Cancel
Save