| | | 1 | | |
| | | 2 | | using Kestrun.Claims; |
| | | 3 | | using Kestrun.Hosting; |
| | | 4 | | using Microsoft.AspNetCore.Authentication; |
| | | 5 | | using Microsoft.AspNetCore.Authentication.Cookies; |
| | | 6 | | using Microsoft.AspNetCore.Authentication.OAuth; |
| | | 7 | | |
| | | 8 | | namespace Kestrun.Authentication; |
| | | 9 | | |
| | | 10 | | /// <summary> |
| | | 11 | | /// Options for OAuth2 authentication. |
| | | 12 | | /// </summary> |
| | | 13 | | public class OAuth2Options : OAuthOptions, IOpenApiAuthenticationOptions, IAuthenticationHostOptions, IOAuthCommonOption |
| | | 14 | | { |
| | | 15 | | /// <summary> |
| | | 16 | | /// Options for cookie authentication. |
| | | 17 | | /// </summary> |
| | 5 | 18 | | public CookieAuthOptions CookieOptions { get; } |
| | | 19 | | |
| | | 20 | | /// <inheritdoc/> |
| | 0 | 21 | | public bool GlobalScheme { get; set; } |
| | | 22 | | |
| | | 23 | | /// <inheritdoc/> |
| | 0 | 24 | | public string? Description { get; set; } |
| | | 25 | | |
| | | 26 | | /// <inheritdoc/> |
| | 0 | 27 | | public string? DisplayName { get; set; } |
| | | 28 | | |
| | | 29 | | /// <inheritdoc/> |
| | 0 | 30 | | public bool Deprecated { get; set; } |
| | | 31 | | |
| | | 32 | | /// <inheritdoc/> |
| | 12 | 33 | | public string[] DocumentationId { get; set; } = []; |
| | | 34 | | |
| | | 35 | | #pragma warning disable IDE0370 // Remove unnecessary suppression |
| | | 36 | | /// <inheritdoc/> |
| | 0 | 37 | | public KestrunHost Host { get; set; } = default!; |
| | | 38 | | #pragma warning restore IDE0370 // Remove unnecessary suppression |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// Initializes a new instance of the <see cref="OAuth2Options"/> class. |
| | | 42 | | /// </summary> |
| | 12 | 43 | | public OAuth2Options() |
| | | 44 | | { |
| | 12 | 45 | | CookieOptions = new CookieAuthOptions() |
| | 12 | 46 | | { |
| | 12 | 47 | | SlidingExpiration = true |
| | 12 | 48 | | }; |
| | 12 | 49 | | } |
| | | 50 | | /// <summary> |
| | | 51 | | /// Gets or sets the authentication scheme name. |
| | | 52 | | /// </summary> |
| | 13 | 53 | | public string AuthenticationScheme { get; set; } = AuthenticationDefaults.OAuth2SchemeName; |
| | | 54 | | |
| | | 55 | | /// <summary> |
| | | 56 | | /// Gets the cookie authentication scheme name. |
| | | 57 | | /// </summary> |
| | | 58 | | public string CookieScheme => |
| | 2 | 59 | | CookieOptions.Cookie.Name ?? (CookieAuthenticationDefaults.AuthenticationScheme + "." + AuthenticationScheme); |
| | | 60 | | |
| | | 61 | | /// <summary> |
| | | 62 | | /// Configuration for claim policy enforcement. |
| | | 63 | | /// </summary> |
| | 10 | 64 | | public ClaimPolicyConfig? ClaimPolicy { get; set; } |
| | | 65 | | |
| | | 66 | | private Serilog.ILogger? _logger; |
| | | 67 | | /// <inheritdoc/> |
| | | 68 | | public Serilog.ILogger Logger |
| | | 69 | | { |
| | 0 | 70 | | get => _logger ?? (Host is null ? Serilog.Log.Logger : Host.Logger); set => _logger = value; |
| | | 71 | | } |
| | | 72 | | |
| | | 73 | | /// <summary> |
| | | 74 | | /// Helper to copy values from a user-supplied OAuth2Options instance to the instance |
| | | 75 | | /// created by the framework inside AddOAuth(). Reassigning the local variable (opts = source) would |
| | | 76 | | /// not work because only the local reference changes – the framework keeps the original instance. |
| | | 77 | | /// </summary> |
| | | 78 | | /// <param name="target">The target OAuth2Options instance to copy values to.</param> |
| | | 79 | | public void ApplyTo(OAuth2Options target) |
| | | 80 | | { |
| | 1 | 81 | | ApplyTo((OAuthOptions)target); |
| | 0 | 82 | | CookieOptions.ApplyTo(target.CookieOptions); |
| | | 83 | | // OpenAPI / documentation properties |
| | 0 | 84 | | target.GlobalScheme = GlobalScheme; |
| | 0 | 85 | | target.Description = Description; |
| | 0 | 86 | | target.DisplayName = DisplayName; |
| | 0 | 87 | | target.DocumentationId = DocumentationId; |
| | 0 | 88 | | target.Host = Host; |
| | 0 | 89 | | target.ClaimPolicy = ClaimPolicy; |
| | 0 | 90 | | target.Deprecated = Deprecated; |
| | 0 | 91 | | } |
| | | 92 | | |
| | | 93 | | /// <summary> |
| | | 94 | | /// Apply these options to the target <see cref="OAuthOptions"/> instance. |
| | | 95 | | /// </summary> |
| | | 96 | | /// <param name="target">The target OAuthOptions instance to apply settings to.</param> |
| | | 97 | | public void ApplyTo(OAuthOptions target) |
| | | 98 | | { |
| | | 99 | | // Core OAuth endpoints |
| | 6 | 100 | | target.AuthorizationEndpoint = AuthorizationEndpoint; |
| | 5 | 101 | | target.TokenEndpoint = TokenEndpoint; |
| | 5 | 102 | | target.UserInformationEndpoint = UserInformationEndpoint; |
| | 5 | 103 | | target.ClientId = ClientId; |
| | 5 | 104 | | target.ClientSecret = ClientSecret; |
| | 5 | 105 | | target.CallbackPath = CallbackPath; |
| | | 106 | | |
| | | 107 | | // OAuth configuration |
| | 5 | 108 | | target.UsePkce = UsePkce; |
| | 5 | 109 | | target.SaveTokens = SaveTokens; |
| | 5 | 110 | | target.ClaimsIssuer = ClaimsIssuer; |
| | | 111 | | |
| | | 112 | | // Scopes - clear and copy |
| | 5 | 113 | | target.Scope.Clear(); |
| | 14 | 114 | | foreach (var scope in Scope) |
| | | 115 | | { |
| | 2 | 116 | | target.Scope.Add(scope); |
| | | 117 | | } |
| | | 118 | | |
| | | 119 | | // Token handling |
| | 5 | 120 | | target.AccessDeniedPath = AccessDeniedPath; |
| | 5 | 121 | | target.RemoteAuthenticationTimeout = RemoteAuthenticationTimeout; |
| | 5 | 122 | | target.ReturnUrlParameter = ReturnUrlParameter; |
| | | 123 | | |
| | | 124 | | // Scheme linkage |
| | 5 | 125 | | target.SignInScheme = SignInScheme; |
| | | 126 | | |
| | | 127 | | // Backchannel configuration |
| | 5 | 128 | | if (Backchannel != null) |
| | | 129 | | { |
| | 0 | 130 | | target.Backchannel = Backchannel; |
| | | 131 | | } |
| | 5 | 132 | | if (BackchannelHttpHandler != null) |
| | | 133 | | { |
| | 0 | 134 | | target.BackchannelHttpHandler = BackchannelHttpHandler; |
| | | 135 | | } |
| | 5 | 136 | | if (BackchannelTimeout != default) |
| | | 137 | | { |
| | 5 | 138 | | target.BackchannelTimeout = BackchannelTimeout; |
| | | 139 | | } |
| | | 140 | | |
| | | 141 | | // Claim actions |
| | 5 | 142 | | if (ClaimActions != null) |
| | | 143 | | { |
| | 14 | 144 | | foreach (var jka in ClaimActions |
| | 5 | 145 | | .OfType<Microsoft.AspNetCore.Authentication.OAuth.Claims.JsonKeyClaimAction>() |
| | 7 | 146 | | .Where(a => !string.IsNullOrEmpty(a.JsonKey) && !string.IsNullOrEmpty(a.ClaimType))) |
| | | 147 | | { |
| | 2 | 148 | | target.ClaimActions.MapJsonKey(jka.ClaimType, jka.JsonKey); |
| | | 149 | | } |
| | | 150 | | } |
| | | 151 | | |
| | | 152 | | // Events - copy if provided |
| | 5 | 153 | | if (Events != null) |
| | | 154 | | { |
| | 5 | 155 | | target.Events = Events; |
| | | 156 | | } |
| | 5 | 157 | | if (EventsType != null) |
| | | 158 | | { |
| | 0 | 159 | | target.EventsType = EventsType; |
| | | 160 | | } |
| | | 161 | | |
| | | 162 | | // Other properties |
| | 5 | 163 | | target.StateDataFormat = StateDataFormat; |
| | 5 | 164 | | } |
| | | 165 | | } |