SampleWebApi project added.

Author: mihirdilip

Mihir.AspNetCore.Authentication.Basic.sln

@@ -11,6 +11,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		README.md = README.md
 	EndProjectSection
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SampleWebApi", "SampleWebApi\SampleWebApi.csproj", "{1DB7BD52-D1E0-4248-819F-8424AFF55689}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -21,6 +23,10 @@ Global
 		{F8FEFB06-9F93-4F50-8530-80F5C0A677FC}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{F8FEFB06-9F93-4F50-8530-80F5C0A677FC}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{F8FEFB06-9F93-4F50-8530-80F5C0A677FC}.Release|Any CPU.Build.0 = Release|Any CPU
+		{1DB7BD52-D1E0-4248-819F-8424AFF55689}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{1DB7BD52-D1E0-4248-819F-8424AFF55689}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{1DB7BD52-D1E0-4248-819F-8424AFF55689}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{1DB7BD52-D1E0-4248-819F-8424AFF55689}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

SampleWebApi/Controllers/ValuesController.cs

@@ -0,0 +1,41 @@
+using Microsoft.AspNetCore.Mvc;
+using System.Collections.Generic;
+
+namespace SampleWebApi.Controllers
+{
+	[Route("api/[controller]")]
+	public class ValuesController : Controller
+	{
+		// GET api/values
+		[HttpGet]
+		public IEnumerable<string> Get()
+		{
+			return new string[] { "value1", "value2" };
+		}
+
+		// GET api/values/5
+		[HttpGet("{id}")]
+		public string Get(int id)
+		{
+			return "value";
+		}
+
+		// POST api/values
+		[HttpPost]
+		public void Post([FromBody]string value)
+		{
+		}
+
+		// PUT api/values/5
+		[HttpPut("{id}")]
+		public void Put(int id, [FromBody]string value)
+		{
+		}
+
+		// DELETE api/values/5
+		[HttpDelete("{id}")]
+		public void Delete(int id)
+		{
+		}
+	}
+}

SampleWebApi/Models/User.cs

@@ -0,0 +1,11 @@
+namespace SampleWebApi.Models
+{
+	/// <summary>
+	/// NOTE: DO NOT USE THIS IMPLEMENTATION. THIS IS FOR DEMO PURPOSE ONLY
+	/// </summary>
+	public class User
+	{
+		public string Username { get; set; }
+		public string Password { get; set; }
+	}
+}

SampleWebApi/Program.cs

@@ -0,0 +1,18 @@
+using Microsoft.AspNetCore;
+using Microsoft.AspNetCore.Hosting;
+
+namespace SampleWebApi
+{
+	public class Program
+	{
+		public static void Main(string[] args)
+		{
+			BuildWebHost(args).Run();
+		}
+
+		public static IWebHost BuildWebHost(string[] args) =>
+			WebHost.CreateDefaultBuilder(args)
+				.UseStartup<Startup>()
+				.Build();
+	}
+}

SampleWebApi/Properties/launchSettings.json

@@ -0,0 +1,29 @@
+{
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:3920/",
+      "sslPort": 0
+    }
+  },
+  "profiles": {
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "launchUrl": "api/values",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "SampleWebApi": {
+      "commandName": "Project",
+      "launchBrowser": true,
+      "launchUrl": "api/values",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      },
+      "applicationUrl": "http://localhost:3921/"
+    }
+  }
+}

SampleWebApi/Repositories/IUserRepository.cs

@@ -0,0 +1,15 @@
+using SampleWebApi.Models;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace SampleWebApi.Repositories
+{
+	/// <summary>
+	/// NOTE: DO NOT USE THIS IMPLEMENTATION. THIS IS FOR DEMO PURPOSE ONLY
+	/// </summary>
+	public interface IUserRepository
+	{
+		Task<User> GetUserByUsername(string username);
+		Task<IEnumerable<User>> GetUsers();
+	}
+}

SampleWebApi/Repositories/InMemoryUserRepository.cs

@@ -0,0 +1,32 @@
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using SampleWebApi.Models;
+
+namespace SampleWebApi.Repositories
+{
+	/// <summary>
+	/// NOTE: DO NOT USE THIS IMPLEMENTATION. THIS IS FOR DEMO PURPOSE ONLY
+	/// </summary>
+	public class InMemoryUserRepository : IUserRepository
+	{
+		private List<User> _users = new List<User>
+		{
+			new User { Username = "TestUser1", Password = "1234" },
+			new User { Username = "TestUser2", Password = "1234" },
+			new User { Username = "TestUser3", Password = "1234" },
+			new User { Username = "TestUser4", Password = "1234" }
+		};
+
+
+		public Task<User> GetUserByUsername(string username)
+		{
+			return Task.FromResult(_users.FirstOrDefault(u => u.Username == username));
+		}
+
+		public Task<IEnumerable<User>> GetUsers()
+		{
+			return Task.FromResult<IEnumerable<User>>(_users);
+		}
+	}
+}

SampleWebApi/SampleWebApi.csproj

@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp2.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Folder Include="wwwroot\" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.All" Version="2.0.6" />
+    <PackageReference Include="Mihir.AspNetCore.Authentication.Basic" Version="1.0.2" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <DotNetCliToolReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Tools" Version="2.0.3" />
+  </ItemGroup>
+
+</Project>

SampleWebApi/Services/BasicUserValidationService.cs

@@ -0,0 +1,37 @@
+using System;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+using Mihir.AspNetCore.Authentication.Basic;
+using SampleWebApi.Repositories;
+
+namespace SampleWebApi.Services
+{
+	internal class BasicUserValidationService : IBasicUserValidationService
+	{
+		private readonly ILogger<BasicUserValidationService> _logger;
+		private readonly IUserRepository _userRepository;
+
+		public BasicUserValidationService(ILogger<BasicUserValidationService> logger, IUserRepository userRepository)
+		{
+			_logger = logger;
+			_userRepository = userRepository;
+		}
+
+		public async Task<bool> IsValidAsync(string username, string password)
+		{
+			try
+			{
+				// NOTE: DO NOT USE THIS IMPLEMENTATION. THIS IS FOR DEMO PURPOSE ONLY
+				// Write your implementation here and return true or false depending on the validation..
+				var user = await _userRepository.GetUserByUsername(username);
+				var isValid = user.Password == password;
+				return isValid;
+			}
+			catch (Exception e)
+			{
+				_logger.LogError(e, e.Message);
+				throw;
+			}
+		}
+	}
+}

SampleWebApi/Startup.cs

@@ -0,0 +1,64 @@
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Mvc.Authorization;
+using Microsoft.AspNetCore.Rewrite;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Mihir.AspNetCore.Authentication.Basic;
+using SampleWebApi.Repositories;
+using SampleWebApi.Services;
+
+namespace SampleWebApi
+{
+	public class Startup
+	{
+		public Startup(IConfiguration configuration)
+		{
+			Configuration = configuration;
+		}
+
+		public IConfiguration Configuration { get; }
+
+		// This method gets called by the runtime. Use this method to add services to the container.
+		public void ConfigureServices(IServiceCollection services)
+		{
+			// Add User repository to the dependency container.
+			services.AddTransient<IUserRepository, InMemoryUserRepository>();
+
+			// 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 = "Sample Web API"; });
+
+			services.AddMvc(options =>
+				{
+					// ALWAYS USE HTTPS (SSL) protocol in production when using Basic authentication.
+					//options.Filters.Add<RequireHttpsAttribute>();
+
+					// All the requests will need to be authorized. 
+					// Alternatively, add [Authorize] attribute to Controller or Action Method where necessary.
+					options.Filters.Add(new AuthorizeFilter(new AuthorizationPolicyBuilder().RequireAuthenticatedUser().Build()));
+				}
+			).AddXmlSerializerFormatters();	// To enable XML along with JSON
+		}
+
+		// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
+		public void Configure(IApplicationBuilder app, IHostingEnvironment env)
+		{
+			if (env.IsDevelopment())
+			{
+				app.UseDeveloperExceptionPage();
+			}
+			else
+			{
+				// ALWAYS USE HTTPS (SSL) protocol in production when using Basic authentication.
+				app.UseRewriter(new RewriteOptions().AddRedirectToHttpsPermanent());
+			}
+
+			app.UseAuthentication();
+			app.UseMvc();
+		}
+	}
+}