Readme and License updated

Author: mihirdilip

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Mihir Dilip
+Copyright (c) 2020 Mihir Dilip
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -18,15 +18,64 @@ PM> Install-Package AspNetCore.Authentication.Basic
 
 ## Example Usage
 
-Setting it up is quite simple. You will need basic working knowledge of ASP.NET Core 2.2 to get started using this code.
+Setting it up is quite simple. You will need basic working knowledge of ASP.NET Core 2.2 or newer to get started using this code.
 
 On [**Startup.cs**](#startupcs), as shown below, add 2 lines in *ConfigureServices* method `services.AddAuthentication(BasicDefaults.AuthenticationScheme).AddBasic<BasicUserValidationService>(options => { options.Realm = "My App"; });`. And a line `app.UseAuthentication();` in *Configure* method.
 
 Also add an implementation of *IBasicUserValidationService* as shown below in [**BasicUserValidationService.cs**](#basicuservalidationservicecs).
 
 **NOTE: Always use HTTPS (SSL Certificate) protocol in production when using Basic authentication.**
 
-#### Startup.cs
+#### Startup.cs (ASP.NET Core 3.0 or newer)
+
+```C#
+using AspNetCore.Authentication.Basic;
+public class Startup
+{
+	public Startup(IConfiguration configuration)
+	{
+		Configuration = configuration;
+	}
+
+	public IConfiguration Configuration { get; }
+
+	public void ConfigureServices(IServiceCollection services)
+	{
+		// Add the Basic scheme authentication here..
+		// AddBasic extension takes an implementation of IBasicUserValidationService for validating the username and password. 
+		// It also requires Realm to be set in the options.
+		services.AddAuthentication(BasicDefaults.AuthenticationScheme)
+			.AddBasic<BasicUserValidationService>(options => { options.Realm = "My App"; });
+
+		services.AddControllers();
+
+		//// By default, authentication is not challenged for every request which is ASP.NET Core's default intended behaviour.
+		//// So to challenge authentication for every requests please use below option instead of above services.AddControllers().
+		//services.AddControllers(options => 
+		//{
+		//	options.Filters.Add(new AuthorizeFilter(new AuthorizationPolicyBuilder().RequireAuthenticatedUser().Build()));
+		//});
+	}
+
+	public void Configure(IApplicationBuilder app, IHostingEnvironment env)
+	{
+		app.UseHttpsRedirection();
+
+		// The below order of pipeline chain is important!
+		app.UseRouting();
+
+		app.UseAuthentication();
+		app.UseAuthorization();
+
+		app.UseEndpoints(endpoints =>
+		{
+			endpoints.MapControllers();
+		});
+	}
+}
+```
+
+#### Startup.cs (ASP.NET Core 2.2)
 
 ```C#
 using AspNetCore.Authentication.Basic;
@@ -48,6 +97,13 @@ public class Startup
 			.AddBasic<BasicUserValidationService>(options => { options.Realm = "My App"; });
 
 		services.AddMvc();
+
+		//// By default, authentication is not challenged for every request which is ASP.NET Core's default intended behaviour.
+		//// So to challenge authentication for every requests please use below option instead of above services.AddMvc().
+		//services.AddMvc(options => 
+		//{
+		//	options.Filters.Add(new AuthorizeFilter(new AuthorizationPolicyBuilder().RequireAuthenticatedUser().Build()));
+		//});
 	}
 
 	public void Configure(IApplicationBuilder app, IHostingEnvironment env)
@@ -86,7 +142,36 @@ public class BasicUserValidationService : IBasicUserValidationService
 }
 ```
 
- 
+## Additional Notes
+Please note that, by default, with ASP.NET Core, all the requests are not challenged for authentication. So don't worry if your *BasicUserValidationService* is not hit when you don't pass the required basic authentication details with the request. It is a normal behaviour. ASP.NET Core challenges authentication only when it is specifically told to do so either by decorating controller/method with *[Authorize]* filter attribute or by some other means. 
+
+However, if you want all the requests to challenge authentication by default, depending on what you are using, you can add the below options line to *ConfigureServices* method on *Startup* class.
+
+```C#
+services.AddControllers(options => 
+{ 
+    options.Filters.Add(new AuthorizeFilter(new AuthorizationPolicyBuilder().RequireAuthenticatedUser().Build()));
+});
+
+// OR
+
+services.AddMvc(options => 
+{
+    options.Filters.Add(new AuthorizeFilter(new AuthorizationPolicyBuilder().RequireAuthenticatedUser().Build()));
+});
+```
+  
+If you are not using MVC but, using Endpoints on ASP.NET Core 3.0 or newer, you can add a chain method `.RequireAuthorization()` to the endpoint map under *Configure* method on *Startup* class as shown below.
+
+```C#
+app.UseEndpoints(endpoints =>
+{
+    endpoints.MapGet("/", async context =>
+    {
+        await context.Response.WriteAsync("Hello World!");
+    }).RequireAuthorization();  // NOTE THIS HERE!!!! 
+});
+``` 
 
 ## References
 - [Creating an authentication scheme in ASP.NET Core 2.0](https://joonasw.net/view/creating-auth-scheme-in-aspnet-core-2)

src/AspNetCore.Authentication.Basic.sln

@@ -13,8 +13,16 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SampleWebApi_2_2", "..\samp
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AspNetCore.Authentication.Basic", "AspNetCore.Authentication.Basic\AspNetCore.Authentication.Basic.csproj", "{B2492C13-5F4E-4002-9E66-0ACF73045668}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{7BFEA4E3-5506-40A1-B6EB-BC8BA3687D23}"
+	ProjectSection(SolutionItems) = preProject
+		..\LICENSE.txt = ..\LICENSE.txt
+		..\README.md = ..\README.md
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SharedMSBuildProjectFiles) = preSolution
+		..\samples\SampleWebApi.Shared\SampleWebApi.Shared.projitems*{07c59e2a-3e40-4fc0-a8cf-0656ab00e8a7}*SharedItemsImports = 5
+		..\samples\SampleWebApi.Shared\SampleWebApi.Shared.projitems*{0801aed9-ea38-4e7e-af4d-26e9b67e5254}*SharedItemsImports = 5
 		..\samples\SampleWebApi.Shared\SampleWebApi.Shared.projitems*{e544fb20-29f3-41f5-a78e-6164f9c43b3c}*SharedItemsImports = 13
 	EndGlobalSection
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution