| | | 1 | | using Kestrun.Claims; |
| | | 2 | | using Kestrun.Hosting; |
| | | 3 | | using Microsoft.AspNetCore.Authentication; |
| | | 4 | | using Microsoft.AspNetCore.Authentication.Cookies; |
| | | 5 | | using Microsoft.AspNetCore.Authentication.OpenIdConnect; |
| | | 6 | | |
| | | 7 | | namespace Kestrun.Authentication; |
| | | 8 | | |
| | | 9 | | /// <summary> |
| | | 10 | | /// Options for OpenID Connect authentication. |
| | | 11 | | /// </summary> |
| | | 12 | | public class OidcOptions : OpenIdConnectOptions, IOpenApiAuthenticationOptions, IAuthenticationHostOptions, IOAuthCommon |
| | | 13 | | { |
| | | 14 | | /// <summary> |
| | | 15 | | /// Options for cookie authentication. |
| | | 16 | | /// </summary> |
| | 7 | 17 | | public CookieAuthOptions CookieOptions { get; } |
| | | 18 | | |
| | | 19 | | /// <summary> |
| | | 20 | | /// Gets the cookie authentication scheme name. |
| | | 21 | | /// </summary> |
| | | 22 | | public string CookieScheme => |
| | 4 | 23 | | CookieOptions.Cookie.Name ?? (CookieAuthenticationDefaults.AuthenticationScheme + "." + AuthenticationScheme); |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// JSON Web Key (JWK) for token validation. |
| | | 27 | | /// </summary> |
| | 10 | 28 | | public string? JwkJson { get; set; } |
| | | 29 | | |
| | | 30 | | #if NET8_0 |
| | | 31 | | /// <summary> |
| | | 32 | | /// Additional authorization parameters to include in the authorization request. |
| | | 33 | | /// </summary> |
| | | 34 | | public string PushedAuthorizationBehavior { get; set; } = "Disable"; |
| | | 35 | | #endif |
| | | 36 | | |
| | | 37 | | /// <inheritdoc/> |
| | 3 | 38 | | public bool GlobalScheme { get; set; } |
| | | 39 | | |
| | | 40 | | /// <inheritdoc/> |
| | 3 | 41 | | public string? Description { get; set; } |
| | | 42 | | |
| | | 43 | | /// <inheritdoc/> |
| | 2 | 44 | | public string? DisplayName { get; set; } |
| | | 45 | | |
| | | 46 | | /// <inheritdoc/> |
| | 20 | 47 | | public string[] DocumentationId { get; set; } = []; |
| | | 48 | | |
| | | 49 | | /// <inheritdoc/> |
| | | 50 | | #pragma warning disable IDE0370 // Remove unnecessary suppression |
| | 4 | 51 | | public KestrunHost Host { get; set; } = default!; |
| | | 52 | | #pragma warning restore IDE0370 // Remove unnecessary suppression |
| | | 53 | | |
| | | 54 | | private Serilog.ILogger? _logger; |
| | | 55 | | /// <inheritdoc/> |
| | | 56 | | public Serilog.ILogger Logger |
| | | 57 | | { |
| | 0 | 58 | | get => _logger ?? (Host is null ? Serilog.Log.Logger : Host.Logger); set => _logger = value; |
| | | 59 | | } |
| | | 60 | | |
| | | 61 | | /// <summary> |
| | | 62 | | /// Initializes a new instance of the <see cref="OidcOptions"/> class. |
| | | 63 | | /// </summary> |
| | 14 | 64 | | public OidcOptions() |
| | | 65 | | { |
| | 14 | 66 | | CookieOptions = new CookieAuthOptions() |
| | 14 | 67 | | { |
| | 14 | 68 | | SlidingExpiration = true |
| | 14 | 69 | | }; |
| | 14 | 70 | | } |
| | | 71 | | |
| | | 72 | | /// <summary> |
| | | 73 | | /// Gets or sets the authentication scheme name. |
| | | 74 | | /// </summary> |
| | 20 | 75 | | public string AuthenticationScheme { get; set; } = AuthenticationDefaults.OidcSchemeName; |
| | | 76 | | |
| | | 77 | | /// <summary> |
| | | 78 | | /// Configuration for claim policy enforcement. |
| | | 79 | | /// </summary> |
| | 5 | 80 | | public ClaimPolicyConfig? ClaimPolicy { get; set; } |
| | | 81 | | |
| | | 82 | | /// <inheritdoc/> |
| | 1 | 83 | | public bool Deprecated { get; set; } |
| | | 84 | | |
| | | 85 | | /// <summary> |
| | | 86 | | /// Helper to copy values from a user-supplied OidcOptions instance to the instance |
| | | 87 | | /// created by the framework inside AddOpenIdConnect(). |
| | | 88 | | /// </summary> |
| | | 89 | | /// <param name="target">The target options to copy to.</param> |
| | | 90 | | public void ApplyTo(OidcOptions target) |
| | | 91 | | { |
| | 2 | 92 | | ApplyTo((OpenIdConnectOptions)target); |
| | 1 | 93 | | target.JwkJson = JwkJson; |
| | | 94 | | // OpenAPI / documentation properties |
| | 1 | 95 | | target.GlobalScheme = GlobalScheme; |
| | 1 | 96 | | target.Description = Description; |
| | 1 | 97 | | target.DisplayName = DisplayName; |
| | 1 | 98 | | target.DocumentationId = DocumentationId; |
| | 1 | 99 | | target.Host = Host; |
| | 1 | 100 | | } |
| | | 101 | | |
| | | 102 | | /// <summary> |
| | | 103 | | /// Helper to copy values from a user-supplied OpenIdConnectOptions instance to the instance |
| | | 104 | | /// created by the framework inside AddOpenIdConnect(). |
| | | 105 | | /// </summary> |
| | | 106 | | /// <param name="target">The target options to copy to.</param> |
| | | 107 | | public void ApplyTo(OpenIdConnectOptions target) |
| | | 108 | | { |
| | 10 | 109 | | CopyCoreEndpoints(target); |
| | 8 | 110 | | CopyFlowConfiguration(target); |
| | 8 | 111 | | CopyScopes(target); |
| | 8 | 112 | | CopyTokenHandling(target); |
| | 8 | 113 | | CopyPaths(target); |
| | 8 | 114 | | CopyTokenValidation(target); |
| | 8 | 115 | | CopySchemeLinkage(target); |
| | 8 | 116 | | CopyBackchannelConfiguration(target); |
| | 8 | 117 | | CopyConfiguration(target); |
| | 8 | 118 | | CopyClaimActions(target); |
| | 8 | 119 | | CopyEvents(target); |
| | 8 | 120 | | CopyIssuerAndProperties(target); |
| | | 121 | | #if NET9_0_OR_GREATER |
| | 8 | 122 | | CopyNet9Features(target); |
| | | 123 | | #endif |
| | 8 | 124 | | } |
| | | 125 | | |
| | | 126 | | private void CopyCoreEndpoints(OpenIdConnectOptions target) |
| | | 127 | | { |
| | 10 | 128 | | target.Authority = Authority; |
| | 8 | 129 | | target.ClientId = ClientId; |
| | 8 | 130 | | target.ClientSecret = ClientSecret; |
| | 8 | 131 | | } |
| | | 132 | | |
| | | 133 | | private void CopyFlowConfiguration(OpenIdConnectOptions target) |
| | | 134 | | { |
| | 8 | 135 | | target.ResponseType = ResponseType; |
| | 8 | 136 | | target.ResponseMode = ResponseMode; |
| | 8 | 137 | | target.UsePkce = UsePkce; |
| | 8 | 138 | | target.RequireHttpsMetadata = RequireHttpsMetadata; |
| | 8 | 139 | | } |
| | | 140 | | |
| | | 141 | | private void CopyScopes(OpenIdConnectOptions target) |
| | | 142 | | { |
| | 8 | 143 | | target.Scope.Clear(); |
| | 50 | 144 | | foreach (var scope in Scope) |
| | | 145 | | { |
| | 17 | 146 | | target.Scope.Add(scope); |
| | | 147 | | } |
| | 8 | 148 | | } |
| | | 149 | | |
| | | 150 | | private void CopyTokenHandling(OpenIdConnectOptions target) |
| | | 151 | | { |
| | 8 | 152 | | target.SaveTokens = SaveTokens; |
| | 8 | 153 | | target.GetClaimsFromUserInfoEndpoint = GetClaimsFromUserInfoEndpoint; |
| | 8 | 154 | | target.MapInboundClaims = MapInboundClaims; |
| | 8 | 155 | | target.UseSecurityTokenValidator = UseSecurityTokenValidator; |
| | 8 | 156 | | } |
| | | 157 | | |
| | | 158 | | private void CopyPaths(OpenIdConnectOptions target) |
| | | 159 | | { |
| | 8 | 160 | | target.CallbackPath = CallbackPath; |
| | 8 | 161 | | target.SignedOutCallbackPath = SignedOutCallbackPath; |
| | 8 | 162 | | target.SignedOutRedirectUri = SignedOutRedirectUri; |
| | 8 | 163 | | target.RemoteSignOutPath = RemoteSignOutPath; |
| | 8 | 164 | | } |
| | | 165 | | |
| | | 166 | | private void CopyTokenValidation(OpenIdConnectOptions target) |
| | | 167 | | { |
| | 8 | 168 | | if (TokenValidationParameters != null) |
| | | 169 | | { |
| | 8 | 170 | | target.TokenValidationParameters = TokenValidationParameters; |
| | | 171 | | } |
| | 8 | 172 | | } |
| | | 173 | | |
| | | 174 | | private void CopySchemeLinkage(OpenIdConnectOptions target) |
| | | 175 | | { |
| | 8 | 176 | | target.SignInScheme = SignInScheme; |
| | 8 | 177 | | target.SignOutScheme = SignOutScheme; |
| | 8 | 178 | | } |
| | | 179 | | |
| | | 180 | | private void CopyBackchannelConfiguration(OpenIdConnectOptions target) |
| | | 181 | | { |
| | 8 | 182 | | if (Backchannel != null) |
| | | 183 | | { |
| | 0 | 184 | | target.Backchannel = Backchannel; |
| | | 185 | | } |
| | 8 | 186 | | if (BackchannelHttpHandler != null) |
| | | 187 | | { |
| | 0 | 188 | | target.BackchannelHttpHandler = BackchannelHttpHandler; |
| | | 189 | | } |
| | 8 | 190 | | if (BackchannelTimeout != default) |
| | | 191 | | { |
| | 8 | 192 | | target.BackchannelTimeout = BackchannelTimeout; |
| | | 193 | | } |
| | 8 | 194 | | } |
| | | 195 | | |
| | | 196 | | private void CopyConfiguration(OpenIdConnectOptions target) |
| | | 197 | | { |
| | 8 | 198 | | if (Configuration != null) |
| | | 199 | | { |
| | 0 | 200 | | target.Configuration = Configuration; |
| | | 201 | | } |
| | 8 | 202 | | if (ConfigurationManager != null) |
| | | 203 | | { |
| | 0 | 204 | | target.ConfigurationManager = ConfigurationManager; |
| | | 205 | | } |
| | 8 | 206 | | } |
| | | 207 | | |
| | | 208 | | private void CopyClaimActions(OpenIdConnectOptions target) |
| | | 209 | | { |
| | 8 | 210 | | if (ClaimActions == null) |
| | | 211 | | { |
| | 0 | 212 | | return; |
| | | 213 | | } |
| | 116 | 214 | | foreach (var jka in ClaimActions |
| | 8 | 215 | | .OfType<Microsoft.AspNetCore.Authentication.OAuth.Claims.JsonKeyClaimAction>() |
| | 58 | 216 | | .Where(a => !string.IsNullOrEmpty(a.JsonKey) && !string.IsNullOrEmpty(a.ClaimType))) |
| | | 217 | | { |
| | 50 | 218 | | target.ClaimActions.MapJsonKey(jka.ClaimType, jka.JsonKey); |
| | | 219 | | } |
| | 8 | 220 | | } |
| | | 221 | | |
| | | 222 | | private void CopyEvents(OpenIdConnectOptions target) |
| | | 223 | | { |
| | 8 | 224 | | if (Events != null) |
| | | 225 | | { |
| | 8 | 226 | | target.Events = Events; |
| | | 227 | | } |
| | 8 | 228 | | if (EventsType != null) |
| | | 229 | | { |
| | 0 | 230 | | target.EventsType = EventsType; |
| | | 231 | | } |
| | 8 | 232 | | } |
| | | 233 | | |
| | | 234 | | private void CopyIssuerAndProperties(OpenIdConnectOptions target) |
| | | 235 | | { |
| | 8 | 236 | | target.ClaimsIssuer = ClaimsIssuer; |
| | 8 | 237 | | target.DisableTelemetry = DisableTelemetry; |
| | 8 | 238 | | target.MaxAge = MaxAge; |
| | 8 | 239 | | target.ProtocolValidator = ProtocolValidator; |
| | 8 | 240 | | target.RefreshOnIssuerKeyNotFound = RefreshOnIssuerKeyNotFound; |
| | 8 | 241 | | target.Resource = Resource; |
| | 8 | 242 | | target.SkipUnrecognizedRequests = SkipUnrecognizedRequests; |
| | 8 | 243 | | target.StateDataFormat = StateDataFormat; |
| | 8 | 244 | | target.StringDataFormat = StringDataFormat; |
| | 8 | 245 | | } |
| | | 246 | | |
| | | 247 | | #if NET9_0_OR_GREATER |
| | | 248 | | private void CopyNet9Features(OpenIdConnectOptions target) |
| | | 249 | | { |
| | 8 | 250 | | target.PushedAuthorizationBehavior = PushedAuthorizationBehavior; |
| | 8 | 251 | | if (AdditionalAuthorizationParameters != null) |
| | | 252 | | { |
| | 20 | 253 | | foreach (var param in AdditionalAuthorizationParameters) |
| | | 254 | | { |
| | 2 | 255 | | target.AdditionalAuthorizationParameters[param.Key] = param.Value; |
| | | 256 | | } |
| | | 257 | | } |
| | 8 | 258 | | } |
| | | 259 | | #endif |
| | | 260 | | } |