Enable nullable on more authentication projects (#31230)

dotnet · Mar 26, 2021 · 206ed86 · 206ed86
1 parent 70e7c40
commit 206ed86
Show file tree

Hide file tree

Showing 52 changed files with 588 additions and 233 deletions.
diff --git a/src/Security/Authentication/Core/src/Events/RemoteAuthenticationContext.cs b/src/Security/Authentication/Core/src/Events/RemoteAuthenticationContext.cs
@@ -35,7 +35,7 @@ protected RemoteAuthenticationContext(
         /// <summary>
         /// Gets or sets the <see cref="AuthenticationProperties"/>.
         /// </summary>
-        public virtual AuthenticationProperties Properties { get; set; }
+        public virtual AuthenticationProperties? Properties { get; set; }
 
         /// <summary>
         /// Calls success creating a ticket with the <see cref="Principal"/> and <see cref="Properties"/>.

diff --git a/src/Security/Authentication/Core/src/HandleRequestResult.cs b/src/Security/Authentication/Core/src/HandleRequestResult.cs
@@ -52,7 +52,7 @@ public class HandleRequestResult : AuthenticateResult
         /// <param name="failure">The failure exception.</param>
         /// <param name="properties">Additional state values for the authentication session.</param>
         /// <returns>The result.</returns>
-        public static new HandleRequestResult Fail(Exception failure, AuthenticationProperties properties)
+        public static new HandleRequestResult Fail(Exception failure, AuthenticationProperties? properties)
         {
             return new HandleRequestResult() { Failure = failure, Properties = properties };
         }
@@ -71,7 +71,7 @@ public class HandleRequestResult : AuthenticateResult
         /// <param name="failureMessage">The failure message.</param>
         /// <param name="properties">Additional state values for the authentication session.</param>
         /// <returns>The result.</returns>
-        public static new HandleRequestResult Fail(string failureMessage, AuthenticationProperties properties)
+        public static new HandleRequestResult Fail(string failureMessage, AuthenticationProperties? properties)
             => Fail(new Exception(failureMessage), properties);
 
         /// <summary>

diff --git a/src/Security/Authentication/Core/src/IDataSerializer.cs b/src/Security/Authentication/Core/src/IDataSerializer.cs
@@ -23,7 +23,6 @@ public interface IDataSerializer<TModel>
         /// </summary>
         /// <param name="data">The bytes being deserialized.</param>
         /// <returns>The model.</returns>
-        [return: MaybeNull]
-        TModel Deserialize(byte[] data);
+        TModel? Deserialize(byte[] data);
     }
 }
diff --git a/src/Security/Authentication/Core/src/ISecureDataFormat.cs b/src/Security/Authentication/Core/src/ISecureDataFormat.cs
@@ -31,16 +31,14 @@ public interface ISecureDataFormat<TData>
         /// </summary>
         /// <param name="protectedText">The data protected value.</param>
         /// <returns>An instance of <typeparamref name="TData"/>.</returns>
-        [return: MaybeNull]
-        TData Unprotect(string protectedText);
+        TData? Unprotect(string? protectedText);
 
         /// <summary>
         /// Unprotects the specified <paramref name="protectedText"/> using the specified <paramref name="purpose"/>.
         /// </summary>
         /// <param name="protectedText">The data protected value.</param>
         /// <param name="purpose">The purpose.</param>
         /// <returns>An instance of <typeparamref name="TData"/>.</returns>
-        [return: MaybeNull]
-        TData Unprotect(string protectedText, string? purpose);
+        TData? Unprotect(string? protectedText, string? purpose);
     }
 }
diff --git a/src/Security/Authentication/Core/src/PublicAPI.Unshipped.txt b/src/Security/Authentication/Core/src/PublicAPI.Unshipped.txt
@@ -1,3 +1,19 @@
 #nullable enable
 *REMOVED*Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions.ForwardDefaultSelector.get -> System.Func<Microsoft.AspNetCore.Http.HttpContext!, string!>?
 Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions.ForwardDefaultSelector.get -> System.Func<Microsoft.AspNetCore.Http.HttpContext!, string?>?
+Microsoft.AspNetCore.Authentication.IDataSerializer<TModel>.Deserialize(byte[]! data) -> TModel?
+Microsoft.AspNetCore.Authentication.ISecureDataFormat<TData>.Unprotect(string? protectedText) -> TData?
+Microsoft.AspNetCore.Authentication.ISecureDataFormat<TData>.Unprotect(string? protectedText, string? purpose) -> TData?
+Microsoft.AspNetCore.Authentication.SecureDataFormat<TData>.Unprotect(string? protectedText) -> TData?
+Microsoft.AspNetCore.Authentication.SecureDataFormat<TData>.Unprotect(string? protectedText, string? purpose) -> TData?
+static Microsoft.AspNetCore.Authentication.HandleRequestResult.Fail(System.Exception! failure, Microsoft.AspNetCore.Authentication.AuthenticationProperties? properties) -> Microsoft.AspNetCore.Authentication.HandleRequestResult!
+static Microsoft.AspNetCore.Authentication.HandleRequestResult.Fail(string! failureMessage, Microsoft.AspNetCore.Authentication.AuthenticationProperties? properties) -> Microsoft.AspNetCore.Authentication.HandleRequestResult!
+virtual Microsoft.AspNetCore.Authentication.RemoteAuthenticationContext<TOptions>.Properties.get -> Microsoft.AspNetCore.Authentication.AuthenticationProperties?
+*REMOVED*Microsoft.AspNetCore.Authentication.IDataSerializer<TModel>.Deserialize(byte[]! data) -> TModel
+*REMOVED*Microsoft.AspNetCore.Authentication.ISecureDataFormat<TData>.Unprotect(string! protectedText) -> TData
+*REMOVED*Microsoft.AspNetCore.Authentication.ISecureDataFormat<TData>.Unprotect(string! protectedText, string? purpose) -> TData
+*REMOVED*Microsoft.AspNetCore.Authentication.SecureDataFormat<TData>.Unprotect(string! protectedText) -> TData
+*REMOVED*Microsoft.AspNetCore.Authentication.SecureDataFormat<TData>.Unprotect(string! protectedText, string? purpose) -> TData
+*REMOVED*static Microsoft.AspNetCore.Authentication.HandleRequestResult.Fail(System.Exception! failure, Microsoft.AspNetCore.Authentication.AuthenticationProperties! properties) -> Microsoft.AspNetCore.Authentication.HandleRequestResult!
+*REMOVED*static Microsoft.AspNetCore.Authentication.HandleRequestResult.Fail(string! failureMessage, Microsoft.AspNetCore.Authentication.AuthenticationProperties! properties) -> Microsoft.AspNetCore.Authentication.HandleRequestResult!
+*REMOVED*virtual Microsoft.AspNetCore.Authentication.RemoteAuthenticationContext<TOptions>.Properties.get -> Microsoft.AspNetCore.Authentication.AuthenticationProperties!
diff --git a/src/Security/Authentication/Core/src/RemoteAuthenticationHandler.cs b/src/Security/Authentication/Core/src/RemoteAuthenticationHandler.cs
@@ -145,7 +145,7 @@ public virtual async Task<bool> HandleRequestAsync()
             ticket.Properties.RedirectUri = null;
 
             // Mark which provider produced this identity so we can cross-check later in HandleAuthenticateAsync
-            ticketContext.Properties.Items[AuthSchemeKey] = Scheme.Name;
+            ticketContext.Properties!.Items[AuthSchemeKey] = Scheme.Name;
 
             await Events.TicketReceived(ticketContext);
 

diff --git a/src/Security/Authentication/Core/src/SecureDataFormat.cs b/src/Security/Authentication/Core/src/SecureDataFormat.cs
@@ -48,15 +48,13 @@ public string Protect(TData data, string? purpose)
         }
 
         /// <inheritdoc />
-        [return: MaybeNull]
-        public TData Unprotect(string protectedText)
+        public TData? Unprotect(string? protectedText)
         {
             return Unprotect(protectedText, purpose: null);
         }
 
         /// <inheritdoc />
-        [return: MaybeNull]
-        public TData Unprotect(string protectedText, string? purpose)
+        public TData? Unprotect(string? protectedText, string? purpose)
         {
             try
             {

diff --git a/src/Security/Authentication/Facebook/src/FacebookHandler.cs b/src/Security/Authentication/Facebook/src/FacebookHandler.cs
@@ -33,10 +33,10 @@ public FacebookHandler(IOptionsMonitor<FacebookOptions> options, ILoggerFactory
         /// <inheritdoc />
         protected override async Task<AuthenticationTicket> CreateTicketAsync(ClaimsIdentity identity, AuthenticationProperties properties, OAuthTokenResponse tokens)
         {
-            var endpoint = QueryHelpers.AddQueryString(Options.UserInformationEndpoint, "access_token", tokens.AccessToken);
+            var endpoint = QueryHelpers.AddQueryString(Options.UserInformationEndpoint, "access_token", tokens.AccessToken!);
             if (Options.SendAppSecretProof)
             {
-                endpoint = QueryHelpers.AddQueryString(endpoint, "appsecret_proof", GenerateAppSecretProof(tokens.AccessToken));
+                endpoint = QueryHelpers.AddQueryString(endpoint, "appsecret_proof", GenerateAppSecretProof(tokens.AccessToken!));
             }
             if (Options.Fields.Count > 0)
             {
@@ -54,7 +54,7 @@ protected override async Task<AuthenticationTicket> CreateTicketAsync(ClaimsIden
                 var context = new OAuthCreatingTicketContext(new ClaimsPrincipal(identity), properties, Context, Scheme, Options, Backchannel, tokens, payload.RootElement);
                 context.RunClaimActions();
                 await Events.CreatingTicket(context);
-                return new AuthenticationTicket(context.Principal, context.Properties, Scheme.Name);
+                return new AuthenticationTicket(context.Principal!, context.Properties, Scheme.Name);
             }
         }
 

diff --git a/src/Security/Authentication/Facebook/src/Microsoft.AspNetCore.Authentication.Facebook.csproj b/src/Security/Authentication/Facebook/src/Microsoft.AspNetCore.Authentication.Facebook.csproj
@@ -5,6 +5,7 @@
     <TargetFramework>$(DefaultNetCoreTargetFramework)</TargetFramework>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageTags>aspnetcore;authentication;security</PackageTags>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/Security/Authentication/Facebook/src/PublicAPI.Unshipped.txt b/src/Security/Authentication/Facebook/src/PublicAPI.Unshipped.txt
@@ -1 +1,19 @@
 #nullable enable
+Microsoft.AspNetCore.Authentication.Facebook.FacebookHandler.FacebookHandler(Microsoft.Extensions.Options.IOptionsMonitor<Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions!>! options, Microsoft.Extensions.Logging.ILoggerFactory! logger, System.Text.Encodings.Web.UrlEncoder! encoder, Microsoft.AspNetCore.Authentication.ISystemClock! clock) -> void
+Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions.AppId.get -> string!
+Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions.AppId.set -> void
+Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions.AppSecret.get -> string!
+Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions.AppSecret.set -> void
+Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions.Fields.get -> System.Collections.Generic.ICollection<string!>!
+const Microsoft.AspNetCore.Authentication.Facebook.FacebookDefaults.AuthenticationScheme = "Facebook" -> string!
+override Microsoft.AspNetCore.Authentication.Facebook.FacebookHandler.CreateTicketAsync(System.Security.Claims.ClaimsIdentity! identity, Microsoft.AspNetCore.Authentication.AuthenticationProperties! properties, Microsoft.AspNetCore.Authentication.OAuth.OAuthTokenResponse! tokens) -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticationTicket!>!
+override Microsoft.AspNetCore.Authentication.Facebook.FacebookHandler.FormatScope() -> string!
+override Microsoft.AspNetCore.Authentication.Facebook.FacebookHandler.FormatScope(System.Collections.Generic.IEnumerable<string!>! scopes) -> string!
+static Microsoft.Extensions.DependencyInjection.FacebookAuthenticationOptionsExtensions.AddFacebook(this Microsoft.AspNetCore.Authentication.AuthenticationBuilder! builder) -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder!
+static Microsoft.Extensions.DependencyInjection.FacebookAuthenticationOptionsExtensions.AddFacebook(this Microsoft.AspNetCore.Authentication.AuthenticationBuilder! builder, System.Action<Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions!>! configureOptions) -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder!
+static Microsoft.Extensions.DependencyInjection.FacebookAuthenticationOptionsExtensions.AddFacebook(this Microsoft.AspNetCore.Authentication.AuthenticationBuilder! builder, string! authenticationScheme, System.Action<Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions!>! configureOptions) -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder!
+static Microsoft.Extensions.DependencyInjection.FacebookAuthenticationOptionsExtensions.AddFacebook(this Microsoft.AspNetCore.Authentication.AuthenticationBuilder! builder, string! authenticationScheme, string! displayName, System.Action<Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions!>! configureOptions) -> Microsoft.AspNetCore.Authentication.AuthenticationBuilder!
+static readonly Microsoft.AspNetCore.Authentication.Facebook.FacebookDefaults.AuthorizationEndpoint -> string!
+static readonly Microsoft.AspNetCore.Authentication.Facebook.FacebookDefaults.DisplayName -> string!
+static readonly Microsoft.AspNetCore.Authentication.Facebook.FacebookDefaults.TokenEndpoint -> string!
+static readonly Microsoft.AspNetCore.Authentication.Facebook.FacebookDefaults.UserInformationEndpoint -> string!
diff --git a/src/Security/Authentication/Google/src/GoogleChallengeProperties.cs b/src/Security/Authentication/Google/src/GoogleChallengeProperties.cs
@@ -43,22 +43,22 @@ public GoogleChallengeProperties()
         /// Initializes a new instance of <see cref="GoogleChallengeProperties"/>.
         /// </summary>
         /// <inheritdoc />
-        public GoogleChallengeProperties(IDictionary<string, string> items)
+        public GoogleChallengeProperties(IDictionary<string, string?> items)
             : base(items)
         { }
 
         /// <summary>
         /// Initializes a new instance of <see cref="GoogleChallengeProperties"/>.
         /// </summary>
         /// <inheritdoc />
-        public GoogleChallengeProperties(IDictionary<string, string> items, IDictionary<string, object> parameters)
+        public GoogleChallengeProperties(IDictionary<string, string?> items, IDictionary<string, object?> parameters)
             : base(items, parameters)
         { }
 
         /// <summary>
         /// The "access_type" parameter value being used for a challenge request.
         /// </summary>
-        public string AccessType
+        public string? AccessType
         {
             get => GetParameter<string>(AccessTypeKey);
             set => SetParameter(AccessTypeKey, value);
@@ -67,7 +67,7 @@ public string AccessType
         /// <summary>
         /// The "approval_prompt" parameter value being used for a challenge request.
         /// </summary>
-        public string ApprovalPrompt
+        public string? ApprovalPrompt
         {
             get => GetParameter<string>(ApprovalPromptKey);
             set => SetParameter(ApprovalPromptKey, value);
@@ -85,7 +85,7 @@ public bool? IncludeGrantedScopes
         /// <summary>
         /// The "login_hint" parameter value being used for a challenge request.
         /// </summary>
-        public string LoginHint
+        public string? LoginHint
         {
             get => GetParameter<string>(LoginHintKey);
             set => SetParameter(LoginHintKey, value);
@@ -94,7 +94,7 @@ public string LoginHint
         /// <summary>
         /// The "prompt" parameter value being used for a challenge request.
         /// </summary>
-        public string Prompt
+        public string? Prompt
         {
             get => GetParameter<string>(PromptParameterKey);
             set => SetParameter(PromptParameterKey, value);

diff --git a/src/Security/Authentication/Google/src/GoogleHandler.cs b/src/Security/Authentication/Google/src/GoogleHandler.cs
@@ -51,7 +51,7 @@ protected override async Task<AuthenticationTicket> CreateTicketAsync(
                 var context = new OAuthCreatingTicketContext(new ClaimsPrincipal(identity), properties, Context, Scheme, Options, Backchannel, tokens, payload.RootElement);
                 context.RunClaimActions();
                 await Events.CreatingTicket(context);
-                return new AuthenticationTicket(context.Principal, context.Properties, Scheme.Name);
+                return new AuthenticationTicket(context.Principal!, context.Properties, Scheme.Name);
             }
         }
 
@@ -76,18 +76,18 @@ protected override string BuildChallengeUrl(AuthenticationProperties properties,
             var state = Options.StateDataFormat.Protect(properties);
             queryStrings.Add("state", state);
 
-            var authorizationEndpoint = QueryHelpers.AddQueryString(Options.AuthorizationEndpoint, queryStrings);
+            var authorizationEndpoint = QueryHelpers.AddQueryString(Options.AuthorizationEndpoint, queryStrings!);
             return authorizationEndpoint;
         }
 
         private static void AddQueryString<T>(
             IDictionary<string, string> queryStrings,
             AuthenticationProperties properties,
             string name,
-            Func<T, string> formatter,
+            Func<T, string?> formatter,
             T defaultValue)
         {
-            string value = null;
+            string? value;
             var parameterValue = properties.GetParameter<T>(name);
             if (parameterValue != null)
             {
@@ -111,7 +111,7 @@ private static void AddQueryString(
             IDictionary<string, string> queryStrings,
             AuthenticationProperties properties,
             string name,
-            string defaultValue = null)
+            string? defaultValue = null)
             => AddQueryString(queryStrings, properties, name, x => x, defaultValue);
     }
 }
diff --git a/src/Security/Authentication/Google/src/GoogleOptions.cs b/src/Security/Authentication/Google/src/GoogleOptions.cs
@@ -40,6 +40,6 @@ public GoogleOptions()
         /// Set the value to offline if your application needs to refresh access tokens when the user is not present at the browser.
         /// </para>
         /// </summary>
-        public string AccessType { get; set; }
+        public string? AccessType { get; set; }
     }
 }
diff --git a/src/Security/Authentication/Google/src/Microsoft.AspNetCore.Authentication.Google.csproj b/src/Security/Authentication/Google/src/Microsoft.AspNetCore.Authentication.Google.csproj
@@ -5,6 +5,7 @@
     <TargetFramework>$(DefaultNetCoreTargetFramework)</TargetFramework>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageTags>aspnetcore;authentication;security</PackageTags>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>