Added Authentication

.github/workflows/google-cloudrun-docker.yml

@@ -111,6 +111,7 @@ jobs:
           image: ${{ env.GAR_LOCATION }}-docker.pkg.dev/${{ env.PROJECT_ID }}/${{env.GAR_REPO}}/${{ env.SERVICE }}:${{ github.sha }}
           secrets: |
             AiTestimonials__PostgresConnectionString=vercel-postgres-secret:latest
+            API_KEY=dzachdev-api-key-secret:latest
 
       # If required, use the Cloud Run url output in later steps
       - name: Show Output

AiTestimonials/Authorization/ApiKeyMiddleware.cs

@@ -0,0 +1,42 @@
+using System.Net;
+
+namespace AiTestimonials.Authorization;
+
+public class ApiKeyMiddleware
+{
+    private readonly RequestDelegate _next;
+    private readonly IApiKeyValidation _apiKeyValidation;
+
+    private readonly List<string> _utilityEndpoints =
+    [
+        "/health/ready",
+        "/health/live"
+    ];
+
+    public ApiKeyMiddleware(RequestDelegate next, IApiKeyValidation apiKeyValidation)
+    {
+        _next = next;
+        _apiKeyValidation = apiKeyValidation;
+    }
+    public async Task InvokeAsync(HttpContext context)
+    {
+        if (_utilityEndpoints.Contains(context.Request.Path))
+        {
+            await _next(context);
+            return;
+        }
+
+        if (string.IsNullOrWhiteSpace(context.Request.Headers[AuthConstants.ApiKeyHeaderName]))
+        {
+            context.Response.StatusCode = (int)HttpStatusCode.BadRequest;
+            return;
+        }
+        string? userApiKey = context.Request.Headers[AuthConstants.ApiKeyHeaderName];
+        if (!_apiKeyValidation.IsValidApiKey(userApiKey!))
+        {
+            context.Response.StatusCode = (int)HttpStatusCode.Unauthorized;
+            return;
+        }
+        await _next(context);
+    }
+}

AiTestimonials/Authorization/ApiKeyValidation.cs

@@ -0,0 +1,15 @@
+namespace AiTestimonials.Authorization;
+
+internal sealed class ApiKeyValidation(IConfiguration configuration) : IApiKeyValidation
+{
+    public bool IsValidApiKey(string userApiKey)
+    {
+        if (string.IsNullOrWhiteSpace(userApiKey))
+        {
+            return false;
+        }
+
+        var apiKey = configuration.GetValue<string>(AuthConstants.ApiKeyName);
+        return apiKey != null && apiKey == userApiKey;
+    }
+}

AiTestimonials/Authorization/AuthConstants.cs

@@ -0,0 +1,7 @@
+namespace AiTestimonials.Authorization;
+
+public static class AuthConstants
+{
+    public const string ApiKeyHeaderName = "x-api-key";
+    public const string ApiKeyName = "API_KEY";
+}

AiTestimonials/Authorization/IApiKeyValidation.cs

@@ -0,0 +1,6 @@
+namespace AiTestimonials.Authorization;
+
+public interface IApiKeyValidation
+{
+    bool IsValidApiKey(string userApiKey);
+}

AiTestimonials/Program.cs

@@ -2,6 +2,9 @@
 using AiTestimonials.Options;
 using AiTestimonials.Repository;
 using AiTestimonials.Services;
+using AiTestimonials.Authorization;
+using Swashbuckle.AspNetCore.Swagger;
+using Microsoft.OpenApi.Models;
 
 var builder = WebApplication.CreateBuilder(args);
 
@@ -13,20 +16,53 @@
 builder.Services.AddEndpointsApiExplorer();
 builder.Services.AddSwaggerGen();
 
+builder.Services.AddTransient<IApiKeyValidation, ApiKeyValidation>();
 builder.Services.AddScoped<AiTestimonialsService>();
 builder.Services.AddScoped<VercelPostgresRepository>();
 
+builder.Services.AddAuthorization();
+builder.Services.AddAuthentication();
+builder.Services.AddSwaggerGen(c =>
+{
+    c.AddSecurityDefinition(AuthConstants.ApiKeyName, new OpenApiSecurityScheme
+    {
+        Description = "ApiKey must appear in header",
+        Type = SecuritySchemeType.ApiKey,
+        Name = AuthConstants.ApiKeyHeaderName,
+        In = ParameterLocation.Header,
+        Scheme = "ApiKeyScheme"
+    });
+    c.AddSecurityRequirement(new OpenApiSecurityRequirement()
+        {
+            {
+                new OpenApiSecurityScheme()
+                {
+                    Reference = new OpenApiReference
+                    {
+                        Type = ReferenceType.SecurityScheme,
+                        Id = AuthConstants.ApiKeyName
+                    },
+                    In = ParameterLocation.Header
+                },
+                new List<string>()
+            }
+        });
+});
+
 var app = builder.Build();
 
 app.RegisterAiTestimonialsEndpoints();
 
 // Configure the HTTP request pipeline.
 if (app.Environment.IsDevelopment())
 {
-    app.UseSwagger();
+    app.UseSwagger(new SwaggerOptions() { SerializeAsV2 = true, RouteTemplate = "swagger/{documentName}/swaggerV2.{json|yaml}" });
+    app.UseSwagger(new SwaggerOptions() );
     app.UseSwaggerUI();
 }
 
 app.UseHttpsRedirection();
+app.UseMiddleware<ApiKeyMiddleware>();
+app.UseAuthorization();
 
 app.Run();

AiTestimonials/appsettings.Development.json

@@ -11,5 +11,6 @@
     "PostgresDatabase": "",
     "PostgresUser": "",
     "PostgresHost": ""
-  }
+  },
+  "API_KEY": "developer"
 }