Add nullable to Auth.Abstractions, and Auth.Core (#22541)

Author: pranavkm

src/Http/Authentication.Abstractions/ref/Microsoft.AspNetCore.Authentication.Abstractions.csproj

@@ -2,6 +2,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>$(DefaultNetCoreTargetFramework)</TargetFrameworks>
+    <Nullable>annotations</Nullable>
   </PropertyGroup>
   <ItemGroup Condition="'$(TargetFramework)' == '$(DefaultNetCoreTargetFramework)'">
     <Compile Include="Microsoft.AspNetCore.Authentication.Abstractions.netcoreapp.cs" />

src/Http/Authentication.Abstractions/ref/Microsoft.AspNetCore.Authentication.Abstractions.netcoreapp.cs

@@ -24,22 +24,22 @@ protected AuthenticateResult() { }
         /// <summary>
         /// The authentication ticket.
         /// </summary>
-        public AuthenticationTicket Ticket { get; protected set; }
+        public AuthenticationTicket? Ticket { get; protected set; }
 
         /// <summary>
         /// Gets the claims-principal with authenticated user identities.
         /// </summary>
-        public ClaimsPrincipal Principal => Ticket?.Principal;
+        public ClaimsPrincipal? Principal => Ticket?.Principal;
 
         /// <summary>
         /// Additional state values for the authentication session.
         /// </summary>
-        public AuthenticationProperties Properties { get; protected set; }
+        public AuthenticationProperties? Properties { get; protected set; }
 
         /// <summary>
         /// Holds failure information from the authentication.
         /// </summary>
-        public Exception Failure { get; protected set; }
+        public Exception? Failure { get; protected set; }
 
         /// <summary>
         /// Indicates that there was no information returned for this authentication scheme.
@@ -58,11 +58,11 @@ public AuthenticateResult Clone()
             }
             if (Failure != null)
             {
-                return Fail(Failure, Properties.Clone());
+                return Fail(Failure, Properties?.Clone());
             }
             if (Succeeded)
             {
-                return Success(Ticket.Clone());
+                return Success(Ticket!.Clone());
             }
             // This shouldn't happen
             throw new NotImplementedException();
@@ -96,7 +96,7 @@ public static AuthenticateResult NoResult()
         /// </summary>
         /// <param name="failure">The failure exception.</param>
         /// <returns>The result.</returns>
-        public static AuthenticateResult Fail(Exception failure)
+        public static AuthenticateResult Fail(Exception? failure)
         {
             return new AuthenticateResult() { Failure = failure };
         }
@@ -107,7 +107,7 @@ public static AuthenticateResult Fail(Exception failure)
         /// <param name="failure">The failure exception.</param>
         /// <param name="properties">Additional state values for the authentication session.</param>
         /// <returns>The result.</returns>
-        public static AuthenticateResult Fail(Exception failure, AuthenticationProperties properties)
+        public static AuthenticateResult Fail(Exception? failure, AuthenticationProperties? properties)
         {
             return new AuthenticateResult() { Failure = failure, Properties = properties };
         }
@@ -117,7 +117,7 @@ public static AuthenticateResult Fail(Exception failure, AuthenticationPropertie
         /// </summary>
         /// <param name="failureMessage">The failure message.</param>
         /// <returns>The result.</returns>
-        public static AuthenticateResult Fail(string failureMessage)
+        public static AuthenticateResult Fail(string? failureMessage)
             => Fail(new Exception(failureMessage));
 
         /// <summary>
@@ -126,7 +126,7 @@ public static AuthenticateResult Fail(string failureMessage)
         /// <param name="failureMessage">The failure message.</param>
         /// <param name="properties">Additional state values for the authentication session.</param>
         /// <returns>The result.</returns>
-        public static AuthenticateResult Fail(string failureMessage, AuthenticationProperties properties)
+        public static AuthenticateResult Fail(string? failureMessage, AuthenticationProperties? properties)
             => Fail(new Exception(failureMessage), properties);
     }
 }

src/Http/Authentication.Abstractions/src/AuthenticateResult.cs

@@ -18,7 +18,7 @@ public static class AuthenticationHttpContextExtensions
         /// </summary>
         /// <param name="context">The <see cref="HttpContext"/> context.</param>
         /// <returns>The <see cref="AuthenticateResult"/>.</returns>
-        public static Task<AuthenticateResult> AuthenticateAsync(this HttpContext context) =>
+        public static Task<AuthenticateResult?> AuthenticateAsync(this HttpContext context) =>
             context.AuthenticateAsync(scheme: null);
 
         /// <summary>
@@ -27,7 +27,7 @@ public static Task<AuthenticateResult> AuthenticateAsync(this HttpContext contex
         /// <param name="context">The <see cref="HttpContext"/> context.</param>
         /// <param name="scheme">The name of the authentication scheme.</param>
         /// <returns>The <see cref="AuthenticateResult"/>.</returns>
-        public static Task<AuthenticateResult> AuthenticateAsync(this HttpContext context, string scheme) =>
+        public static Task<AuthenticateResult?> AuthenticateAsync(this HttpContext context, string? scheme) =>
             context.RequestServices.GetRequiredService<IAuthenticationService>().AuthenticateAsync(context, scheme);
 
         /// <summary>
@@ -53,7 +53,7 @@ public static Task ChallengeAsync(this HttpContext context) =>
         /// <param name="context">The <see cref="HttpContext"/> context.</param>
         /// <param name="properties">The <see cref="AuthenticationProperties"/> properties.</param>
         /// <returns>The task.</returns>
-        public static Task ChallengeAsync(this HttpContext context, AuthenticationProperties properties) =>
+        public static Task ChallengeAsync(this HttpContext context, AuthenticationProperties? properties) =>
             context.ChallengeAsync(scheme: null, properties: properties);
 
         /// <summary>
@@ -63,7 +63,7 @@ public static Task ChallengeAsync(this HttpContext context, AuthenticationProper
         /// <param name="scheme">The name of the authentication scheme.</param>
         /// <param name="properties">The <see cref="AuthenticationProperties"/> properties.</param>
         /// <returns>The task.</returns>
-        public static Task ChallengeAsync(this HttpContext context, string scheme, AuthenticationProperties properties) =>
+        public static Task ChallengeAsync(this HttpContext context, string? scheme, AuthenticationProperties? properties) =>
             context.RequestServices.GetRequiredService<IAuthenticationService>().ChallengeAsync(context, scheme, properties);
 
         /// <summary>
@@ -89,7 +89,7 @@ public static Task ForbidAsync(this HttpContext context) =>
         /// <param name="context">The <see cref="HttpContext"/> context.</param>
         /// <param name="properties">The <see cref="AuthenticationProperties"/> properties.</param>
         /// <returns>The task.</returns>
-        public static Task ForbidAsync(this HttpContext context, AuthenticationProperties properties) =>
+        public static Task ForbidAsync(this HttpContext context, AuthenticationProperties? properties) =>
             context.ForbidAsync(scheme: null, properties: properties);
 
         /// <summary>
@@ -99,7 +99,7 @@ public static Task ForbidAsync(this HttpContext context, AuthenticationPropertie
         /// <param name="scheme">The name of the authentication scheme.</param>
         /// <param name="properties">The <see cref="AuthenticationProperties"/> properties.</param>
         /// <returns>The task.</returns>
-        public static Task ForbidAsync(this HttpContext context, string scheme, AuthenticationProperties properties) =>
+        public static Task ForbidAsync(this HttpContext context, string? scheme, AuthenticationProperties? properties) =>
             context.RequestServices.GetRequiredService<IAuthenticationService>().ForbidAsync(context, scheme, properties);
 
         /// <summary>
@@ -128,7 +128,7 @@ public static Task SignInAsync(this HttpContext context, ClaimsPrincipal princip
         /// <param name="principal">The user.</param>
         /// <param name="properties">The <see cref="AuthenticationProperties"/> properties.</param>
         /// <returns>The task.</returns>
-        public static Task SignInAsync(this HttpContext context, ClaimsPrincipal principal, AuthenticationProperties properties) =>
+        public static Task SignInAsync(this HttpContext context, ClaimsPrincipal principal, AuthenticationProperties? properties) =>
             context.SignInAsync(scheme: null, principal: principal, properties: properties);
 
         /// <summary>
@@ -139,7 +139,7 @@ public static Task SignInAsync(this HttpContext context, ClaimsPrincipal princip
         /// <param name="principal">The user.</param>
         /// <param name="properties">The <see cref="AuthenticationProperties"/> properties.</param>
         /// <returns>The task.</returns>
-        public static Task SignInAsync(this HttpContext context, string scheme, ClaimsPrincipal principal, AuthenticationProperties properties) =>
+        public static Task SignInAsync(this HttpContext context, string? scheme, ClaimsPrincipal principal, AuthenticationProperties? properties) =>
             context.RequestServices.GetRequiredService<IAuthenticationService>().SignInAsync(context, scheme, principal, properties);
 
         /// <summary>
@@ -155,15 +155,15 @@ public static Task SignInAsync(this HttpContext context, string scheme, ClaimsPr
         /// <param name="context">The <see cref="HttpContext"/> context.</param>
         /// <param name="properties">The <see cref="AuthenticationProperties"/> properties.</param>
         /// <returns>The task.</returns>
-        public static Task SignOutAsync(this HttpContext context, AuthenticationProperties properties) => context.SignOutAsync(scheme: null, properties: properties);
+        public static Task SignOutAsync(this HttpContext context, AuthenticationProperties? properties) => context.SignOutAsync(scheme: null, properties: properties);
 
         /// <summary>
         /// Extension method for SignOut.
         /// </summary>
         /// <param name="context">The <see cref="HttpContext"/> context.</param>
         /// <param name="scheme">The name of the authentication scheme.</param>
         /// <returns>The task.</returns>
-        public static Task SignOutAsync(this HttpContext context, string scheme) => context.SignOutAsync(scheme, properties: null);
+        public static Task SignOutAsync(this HttpContext context, string? scheme) => context.SignOutAsync(scheme, properties: null);
 
         /// <summary>
         /// Extension method for SignOut.
@@ -172,7 +172,7 @@ public static Task SignInAsync(this HttpContext context, string scheme, ClaimsPr
         /// <param name="scheme">The name of the authentication scheme.</param>
         /// <param name="properties">The <see cref="AuthenticationProperties"/> properties.</param>
         /// <returns>The task.</returns>
-        public static Task SignOutAsync(this HttpContext context, string scheme, AuthenticationProperties properties) =>
+        public static Task SignOutAsync(this HttpContext context, string? scheme, AuthenticationProperties? properties) =>
             context.RequestServices.GetRequiredService<IAuthenticationService>().SignOutAsync(context, scheme, properties);
 
         /// <summary>
@@ -182,7 +182,7 @@ public static Task SignOutAsync(this HttpContext context, string scheme, Authent
         /// <param name="scheme">The name of the authentication scheme.</param>
         /// <param name="tokenName">The name of the token.</param>
         /// <returns>The value of the token.</returns>
-        public static Task<string> GetTokenAsync(this HttpContext context, string scheme, string tokenName) =>
+        public static Task<string?> GetTokenAsync(this HttpContext context, string? scheme, string tokenName) =>
             context.RequestServices.GetRequiredService<IAuthenticationService>().GetTokenAsync(context, scheme, tokenName);
 
         /// <summary>
@@ -191,7 +191,7 @@ public static Task<string> GetTokenAsync(this HttpContext context, string scheme
         /// <param name="context">The <see cref="HttpContext"/> context.</param>
         /// <param name="tokenName">The name of the token.</param>
         /// <returns>The value of the token.</returns>
-        public static Task<string> GetTokenAsync(this HttpContext context, string tokenName) =>
+        public static Task<string?> GetTokenAsync(this HttpContext context, string tokenName) =>
             context.RequestServices.GetRequiredService<IAuthenticationService>().GetTokenAsync(context, tokenName);
     }
 }

src/Http/Authentication.Abstractions/src/AuthenticationHttpContextExtensions.cs

@@ -64,32 +64,32 @@ public void AddScheme<THandler>(string name, string displayName) where THandler
         /// <summary>
         /// Used as the fallback default scheme for all the other defaults.
         /// </summary>
-        public string DefaultScheme { get; set; }
+        public string? DefaultScheme { get; set; }
 
         /// <summary>
         /// Used as the default scheme by <see cref="IAuthenticationService.AuthenticateAsync(HttpContext, string)"/>.
         /// </summary>
-        public string DefaultAuthenticateScheme { get; set; }
+        public string? DefaultAuthenticateScheme { get; set; }
 
         /// <summary>
         /// Used as the default scheme by <see cref="IAuthenticationService.SignInAsync(HttpContext, string, System.Security.Claims.ClaimsPrincipal, AuthenticationProperties)"/>.
         /// </summary>
-        public string DefaultSignInScheme { get; set; }
+        public string? DefaultSignInScheme { get; set; }
 
         /// <summary>
         /// Used as the default scheme by <see cref="IAuthenticationService.SignOutAsync(HttpContext, string, AuthenticationProperties)"/>.
         /// </summary>
-        public string DefaultSignOutScheme { get; set; }
+        public string? DefaultSignOutScheme { get; set; }
 
         /// <summary>
         /// Used as the default scheme by <see cref="IAuthenticationService.ChallengeAsync(HttpContext, string, AuthenticationProperties)"/>.
         /// </summary>
-        public string DefaultChallengeScheme { get; set; }
+        public string? DefaultChallengeScheme { get; set; }
 
         /// <summary>
         /// Used as the default scheme by <see cref="IAuthenticationService.ForbidAsync(HttpContext, string, AuthenticationProperties)"/>.
         /// </summary>
-        public string DefaultForbidScheme { get; set; }
+        public string? DefaultForbidScheme { get; set; }
 
         /// <summary>
         /// If true, SignIn should throw if attempted with a ClaimsPrincipal.Identity.IsAuthenticated = false.