Merge pull request 'Added PayfastCheckoutEndpoint stub' (#17) from payments into master

Reviewed-on: #17

.drone.yml

@@ -82,9 +82,9 @@ steps:
     commands:      
       - mkdir -p $HOME/.kube
       - echo "$KUBE_CONFIG" > $HOME/.kube/config
-      - kubectl apply -f midrandbooks-uat.yml
+      - kubectl apply -f midrandbooksapi-uat.yml
       - sleep 10
-      - kubectl rollout restart deployment/midrandbooks -n midrandbooks-uat
+      - kubectl rollout restart deployment/midrandbooks-api -n midrandbooksapi-uat
 
 depends_on:
   - package
@@ -105,7 +105,7 @@ steps:
     commands:      
       - mkdir -p $HOME/.kube
       - echo "$KUBE_CONFIG" > $HOME/.kube/config
-      - kubectl apply -f midrandbooks.yml
+      - kubectl apply -f midrandbooks-api.yml
 
 depends_on:
   - uat

.gitignore

@@ -360,4 +360,5 @@ MigrationBackup/
 .ionide/
 
 # Fody - auto-generated XML schema
-FodyWeavers.xsd
+FodyWeavers.xsd
+/MidrandBooksApi/http/http-client.env.json

MidrandBooksApi/ApiVersionTargetAttribute.cs

@@ -1,7 +0,0 @@
-namespace MidrandBooksApi;
-
-[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
-public sealed class ApiVersionTargetAttribute(int majorVersion) : Attribute
-{
-    public int MajorVersion { get; } = majorVersion;
-}

MidrandBooksApi/EndpointTags.cs

@@ -1,7 +0,0 @@
-namespace MidrandBooksApi;
-
-public static class EndpointTags
-{
-    public const string Books = nameof(Books);
-    public const string Payments = nameof(Payments);
-}

MidrandBooksApi/IEndpoint.cs

@@ -1,6 +0,0 @@
-namespace MidrandBooksApi;
-
-public interface IEndpoint
-{
-    void Map(IEndpointRouteBuilder builder);
-}

MidrandBooksApi/MidrandBooksApi.csproj

@@ -14,8 +14,8 @@
     <PackageReference Include="IdentityModel.AspNetCore.OAuth2introspection" Version="6.2.0" />
     <PackageReference Include="IdentityServer4.AccessTokenValidation" Version="3.0.1" />
     <PackageReference Include="IdentityModel" Version="6.2.0" />
-    <PackageReference Include="Microsoft.AspNetCore.Authentication.Certificate" Version="10.0.8" />
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.Certificate" Version="10.0.9" />
-    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="10.0.8" />
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="10.0.9" />
   </ItemGroup>
   
   <!-- Health Checks -->
@@ -34,12 +34,13 @@
     <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" Version="10.0.0" />
 
     <Using Include="Asp.Versioning" />
+    <Using Include="Asp.Versioning.Builder" />
   </ItemGroup>
   
   <!-- API Documentation -->
   <ItemGroup>    
-    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.8" />    
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.9" />    
-    <PackageReference Include="Scalar.AspNetCore" Version="2.14.14" />
+    <PackageReference Include="Scalar.AspNetCore" Version="2.16.3" />
 
     <Using Include="Scalar.AspNetCore" />
     <Using Include="Microsoft.OpenApi" />
@@ -53,13 +54,13 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="LiteCharms.Features" Version="1.61.0" />
+    <PackageReference Include="LiteCharms.Features" Version="1.102.0" />
   </ItemGroup>
 
   <!-- UI -->
   <ItemGroup>
     <PackageReference Include="ANM.Blazored.Toast" Version="0.1.1" />
-    <PackageReference Include="LiteCharms.Features.MidrandBooks" Version="1.61.0" />
+    <PackageReference Include="LiteCharms.Features.MidrandBooks" Version="1.102.0" />
 
     <!-- Global Usings -->
     <Using Include="Blazored.Toast.Services" />
@@ -85,7 +86,11 @@
 
   <!-- Shared Global Usings -->
   <ItemGroup>
+    <Using Include="System.Web" />
+    <Using Include="System.Diagnostics" />
     <Using Include="System.Reflection" />
+    <Using Include="Microsoft.AspNetCore.Mvc" />
+    <Using Include="System.ComponentModel.DataAnnotations" />
     <Using Include="Microsoft.Extensions.DependencyInjection.Extensions" />
   </ItemGroup>
 

MidrandBooksApi/OpenApiBearerSecuritySchemeTransformer.cs

@@ -1,16 +0,0 @@
-namespace MidrandBooksApi;
-
-public sealed class OpenApiBearerSecuritySchemeTransformer : IOpenApiDocumentTransformer
-{
-    public async Task TransformAsync(OpenApiDocument document, OpenApiDocumentTransformerContext context, CancellationToken cancellationToken)
-    {
-        var bearerScheme = new OpenApiSecurityScheme
-        {
-            Type = SecuritySchemeType.Http,
-            Scheme = "bearer",
-            Description = "JWT Authorization header using the Bearer scheme. Example: \"Bearer {token}\""
-        };
-
-        document.AddComponent("Bearer", bearerScheme);
-    }
-}

MidrandBooksApi/Payments/Endpoints/ConfirmationEndpoint.cs

@@ -1,43 +0,0 @@
-using LiteCharms.Features.Extensions;
-using LiteCharms.Features.Hasher;
-using LiteCharms.Features.Models;
-
-namespace MidrandBooksApi.Payments.Endpoints;
-
-[ApiVersionTarget(1)]
-public sealed class ConfirmationEndpoint : IEndpoint
-{
-    public void Map(IEndpointRouteBuilder builder)
-    {
-        builder.MapPost("payments/confirm", async (HttpRequest request, HashService hashService,
-            CancellationToken cancellationToken) =>
-        {
-            var formCollection = await request.ReadFormAsync(cancellationToken);
-
-            if (!formCollection.TryGetValue("signature", out var signatureValues) || string.IsNullOrWhiteSpace(signatureValues.ToString())) 
-                return Results.BadRequest("Missing Payfast validation signature.");
-
-            string incomingSignature = signatureValues.ToString();
-
-            var payload = new PayfastWebhookPayload
-            {
-                Amount = formCollection.TryGetValue("amount", out var amountValues) ? amountValues.ToString() : null,
-                ItemName = formCollection.TryGetValue("item_name", out var itemValues) ? itemValues.ToString() : null,
-                MPaymentId = formCollection.TryGetValue("m_payment_id", out var paymentIdValues) ? paymentIdValues.ToString() : null
-            };
-
-            var validationResult = hashService.VerifyPayfastWebhookSignature(payload, incomingSignature);
-
-            return validationResult.IsFailed || !validationResult.Value
-                ? Results.Unauthorized()
-                : Results.Ok();
-        })
-        .WithDescription("Securely confirm and process an incoming Payfast merchant payment callback.")
-        .WithName(typeof(ConfirmationEndpoint).ToEndpointName())
-        .MapToApiVersion(new ApiVersion(1))
-        .Produces(StatusCodes.Status200OK)
-        .Produces(StatusCodes.Status400BadRequest)
-        .Produces(StatusCodes.Status401Unauthorized)
-        .WithTags(EndpointTags.Payments);
-    }
-}

MidrandBooksApi/Payments/Payfast/PayfastCheckoutEndpoint.cs

@@ -0,0 +1,45 @@
+using LiteCharms.Features.Abstractions;
+using LiteCharms.Features.Api;
+using LiteCharms.Features.Extensions;
+using LiteCharms.Features.MidrandBooks.Customers;
+using LiteCharms.Features.MidrandBooks.Payments;
+using LiteCharms.Features.MidrandBooks.Payments.Models;
+using LiteCharms.Features.MidrandBooks.Products;
+using static LiteCharms.Features.Extensions.Api;
+
+namespace MidrandBooksApi.Payments.Payfast;
+
+[ApiVersionTarget(1)]
+public sealed class PayfastCheckoutEndpoint : IEndpoint
+{
+    private static readonly ActivitySource PaymentActivitySource = new("MidrandBooksApi.Payments");
+
+    public void Map(IEndpointRouteBuilder builder)
+    {
+        builder.MapPost("payments/payfast/checkout", ([FromBody, Required] Cart shoppingCart, ProductService productService, 
+            PaymentService paymentService, PayfastService payfastService, CustomerService customerService, IJobOrchestrator jobOrchestrator, 
+            CancellationToken cancellationToken = default) =>
+        {
+            using Activity? activity = PaymentActivitySource.StartActivity("GeneratePayfastCheckoutUrl", ActivityKind.Server);
+
+            activity?.SetTag("messaging.system", "midrandbooks-api");
+            activity?.SetTag("messaging.destination.name", "payments/payfast/checkout");
+
+            // do work
+
+            var checkoutUrl = string.Empty;
+
+            activity?.SetStatus(ActivityStatusCode.Ok);
+
+            return Results.Ok(checkoutUrl);
+        })
+        .RequireAuthorization()
+        .WithDescription("Payfact checkout processor back-channel.")
+        .WithName(typeof(PayfastCheckoutEndpoint).ToEndpointName())
+        .MapToApiVersion(new ApiVersion(1))
+        .Produces<string>(StatusCodes.Status200OK)
+        .Produces(StatusCodes.Status400BadRequest)
+        .Produces(StatusCodes.Status401Unauthorized)
+        .WithTags(Api.Payments); ;
+    }
+}

MidrandBooksApi/Payments/Payfast/PayfastConfirmationEndpoint.cs

@@ -0,0 +1,97 @@
+using LiteCharms.Features.Abstractions;
+using LiteCharms.Features.Api;
+using LiteCharms.Features.Extensions;
+using LiteCharms.Features.MidrandBooks.Payments;
+using LiteCharms.Features.MidrandBooks.Payments.Events;
+using LiteCharms.Features.MidrandBooks.Payments.Models;
+using static LiteCharms.Features.Extensions.Api;
+
+namespace MidrandBooksApi.Payments.Payfast;
+
+[ApiVersionTarget(1)]
+public sealed class PayfastConfirmationEndpoint : IEndpoint
+{
+    private static readonly ActivitySource PaymentActivitySource = new("MidrandBooksApi.Payments");
+
+    public void Map(IEndpointRouteBuilder builder)
+    {
+        builder.MapPost("payments/payfast/confirm", async (HttpRequest request, PayfastService payfastService,
+            IJobOrchestrator jobOrchestrator, IConfiguration configuration, IHostEnvironment hostEnvironment, CancellationToken cancellationToken) =>
+        {
+            using Activity? activity = PaymentActivitySource.StartActivity("ReceivePayfastWebhook", ActivityKind.Server);
+
+            activity?.SetTag("messaging.system", "payfast");
+            activity?.SetTag("messaging.destination.name", "payments/payfast/confirm");
+
+            string? remoteIp = request.HttpContext.Connection.RemoteIpAddress?.ToString();
+
+            var ipValidation = await payfastService.ValidateReferrerIpAsync(remoteIp!, !hostEnvironment.IsProduction(), cancellationToken);
+
+            if (ipValidation.IsFailed || !ipValidation.Value) return Results.Unauthorized();
+
+            var formCollection = await request.ReadFormAsync(cancellationToken);
+
+            if (!formCollection.TryGetValue("signature", out var signatureValues) || string.IsNullOrWhiteSpace(signatureValues.ToString()))
+                return Results.BadRequest("Missing Payfast validation signature.");
+
+            string incomingSignature = signatureValues.ToString().Trim();
+            var payload = ParseForm(formCollection, incomingSignature);
+
+            var paramDictionary = payload.ToParamDictionary();
+            string? passphrase = configuration["HasherSettings:PayfastPassphrase"];
+
+            var signatureCheck = PayfastService.GenerateSignature(paramDictionary, passphrase);
+
+            if (signatureCheck.IsFailed || !string.Equals(signatureCheck.Value, incomingSignature, StringComparison.OrdinalIgnoreCase))
+                return Results.Unauthorized();
+
+            var formPairs = formCollection.Select(kvp => $"{kvp.Key}={HttpUtility.UrlEncode(kvp.Value.ToString())}");
+
+            string rawQueryParamString = string.Join("&", formPairs);
+
+            bool isSandbox = !hostEnvironment.IsProduction();
+
+            var serverConfirmation = await payfastService.ValidateServerConfirmationAsync(rawQueryParamString, isSandbox, cancellationToken);
+
+            if (serverConfirmation.IsFailed || !serverConfirmation.Value)
+                return Results.Unauthorized();
+
+            var notification = PayfastPaymentConfirmationReceivedEvent.Create(payload, payload.MerchantPaymentId!,
+                allowLoopback: !hostEnvironment.IsProduction(), performBackgroundChecks: false);
+
+            await jobOrchestrator.SendAsync(notification, cancellationToken);
+
+            activity?.SetStatus(ActivityStatusCode.Ok);
+
+            return Results.Ok();
+        })
+        .WithDescription("Securely confirm and process an incoming Payfast merchant payment callback.")
+        .WithName(typeof(PayfastConfirmationEndpoint).ToEndpointName())
+        .MapToApiVersion(new ApiVersion(1))
+        .Produces(StatusCodes.Status200OK)
+        .Produces(StatusCodes.Status400BadRequest)
+        .Produces(StatusCodes.Status401Unauthorized)
+        .WithTags(Api.Payments);
+    }
+
+    private static PayfastWebhookPayload ParseForm(IFormCollection formCollection, string incomingSignature) => new()
+    {
+        MerchantId = formCollection.TryGetValue("merchant_id", out var mId) ? mId.ToString() : null,
+        MerchantKey = formCollection.TryGetValue("merchant_key", out var mKey) ? mKey.ToString() : null,
+        Signature = incomingSignature,
+        MerchantPaymentId = formCollection.TryGetValue("m_payment_id", out var mPayId) ? mPayId.ToString() : null,
+        PaymentId = formCollection.TryGetValue("pf_payment_id", out var pfPayId) ? pfPayId.ToString() : null,
+        PaymentStatus = formCollection.TryGetValue("payment_status", out var status) ? status.ToString() : null,
+        ItemName = formCollection.TryGetValue("item_name", out var item) ? item.ToString() : null,
+        ItemDescription = formCollection.TryGetValue("item_description", out var desc) ? desc.ToString() : null,
+        AmountGross = formCollection.TryGetValue("amount_gross", out var gross) ? gross.ToString() : null,
+        AmountFee = formCollection.TryGetValue("amount_fee", out var fee) ? fee.ToString() : null,
+        AmountNet = formCollection.TryGetValue("amount_net", out var net) ? net.ToString() : null,
+        NameFirst = formCollection.TryGetValue("name_first", out var first) ? first.ToString() : null,
+        NameLast = formCollection.TryGetValue("name_last", out var last) ? last.ToString() : null,
+        EmailAddress = formCollection.TryGetValue("email_address", out var email) ? email.ToString() : null,
+        CustomStr1 = formCollection.TryGetValue("custom_str1", out var cStr1) ? cStr1.ToString() : null,
+        CustomInt1 = formCollection.TryGetValue("custom_int1", out var cInt1) ? cInt1.ToString() : null,
+        Token = formCollection.TryGetValue("token", out var tok) ? tok.ToString() : null
+    };
+}

MidrandBooksApi/Program.cs

@@ -1,8 +1,6 @@
-using Asp.Versioning.Builder;
 using LiteCharms.Features.Extensions;
 using LiteCharms.Features.Mediator;
 using LiteCharms.Features.MidrandBooks.Extensions;
-using MidrandBooksApi;
 using static LiteCharms.Features.Extensions.Quartz;
 
 var builder = WebApplication.CreateBuilder(args);
@@ -13,10 +11,8 @@ builder.Services.AddEndpointsApiExplorer();
 builder.Services.AddEndpoints(Assembly.GetExecutingAssembly());
 builder.Services.AddApiServices(builder.Configuration);
 
-builder.Services.AddAuthorization();
-builder.Services.AddAuthentication();
-
 builder.Services.AddMediator();
+builder.Services.AddLiteCharmsApiSecurity(builder.Configuration);
 
 builder.Services.AddScoped(typeof(IPipelineBehavior<,>), typeof(TelemetryPipelineBehavior<,>));
 builder.Services.AddScoped(typeof(IPipelineBehavior<,>), typeof(LoggingPipelineBehavior<,>));
@@ -74,6 +70,10 @@ app.UseHealthChecks("/ready");
 
 app.MapOpenApi();
 
+var apiVersions = app.DescribeApiVersions()
+    .OrderByDescending(o => o.ApiVersion.MajorVersion)
+    .ToList();
+
 foreach (var description in app.DescribeApiVersions().OrderByDescending(o => o.ApiVersion.MajorVersion))
     app.MapScalarApiReference($"/openapi/{description.GroupName}", (options, context) =>
     {
@@ -84,6 +84,10 @@ foreach (var description in app.DescribeApiVersions().OrderByDescending(o => o.A
         options.Authentication = new ScalarAuthenticationOptions { PreferredSecuritySchemes = ["Bearer"] };
     });
 
+var latestVersionGroup = apiVersions.FirstOrDefault()?.GroupName ?? "v1";
+
+app.MapGet("/", () => Results.Redirect($"/openapi/{latestVersionGroup}"))
+   .ExcludeFromDescription();
 
 if (!app.Environment.IsDevelopment())
     app.UseExceptionHandler("/Error", createScopeForErrors: true);

MidrandBooksApi/Properties/launchSettings.json

@@ -13,7 +13,7 @@
     "https": {
       "commandName": "Project",
       "dotnetRunMessages": true,
-      "launchBrowser": false,
+      "launchBrowser": false,      
       "applicationUrl": "https://localhost:7196;http://localhost:5159",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"

MidrandBooksApi/Setup.cs

@@ -1,88 +0,0 @@
-namespace MidrandBooksApi;
-
-public static class Setup
-{
-    public static IApplicationBuilder MapEndpoints(this WebApplication app, Dictionary<int, RouteGroupBuilder> versionGroups)
-    {
-        var endpoints = app.Services.GetRequiredService<IEnumerable<IEndpoint>>();
-
-        foreach (var endpoint in endpoints)
-        {
-            var versionAttributes = endpoint.GetType().GetCustomAttributes<ApiVersionTargetAttribute>().ToList();
-
-            if (versionAttributes.Count != 0)
-            {
-                foreach (var attr in versionAttributes)
-                    if (versionGroups.TryGetValue(attr.MajorVersion, out var targetGroup))
-                        endpoint.Map(targetGroup);
-            }
-            else
-                endpoint.Map(app);
-        }
-
-        return app;
-    }
-
-    public static IServiceCollection AddEndpoints(this IServiceCollection services, Assembly assembly)
-    {
-        ServiceDescriptor[] discriptors = [.. assembly.DefinedTypes
-            .Where(t => t is { IsInterface: false, IsAbstract: false })
-            .Where(t => t.IsAssignableTo(typeof(IEndpoint)))
-            .Select(t => ServiceDescriptor.Transient(typeof(IEndpoint), t))];
-
-        services.TryAddEnumerable(discriptors);
-
-        return services;
-    }
-
-    public static string ToEndpointName(this Type target, string? annotation = "") =>
-        $"{target.Name.Replace("Endpoint", string.Empty)}{annotation}".ToLower();
-
-    public static IServiceCollection AddApiServices(this IServiceCollection services, IConfiguration configuration)
-    {
-        services.AddApiVersioning(options =>
-        {
-            options.DefaultApiVersion = new ApiVersion(1);
-            options.ReportApiVersions = true;
-            options.AssumeDefaultVersionWhenUnspecified = true;
-            options.ApiVersionReader = ApiVersionReader.Combine(new UrlSegmentApiVersionReader(),
-                new QueryStringApiVersionReader("version"),
-                new QueryStringApiVersionReader("version"),
-                new MediaTypeApiVersionReader("version"));
-        })
-        .AddApiExplorer(options =>
-        {
-            options.GroupNameFormat = "'v'VVV";
-            options.SubstituteApiVersionInUrl = true;
-        });
-
-        var urls = configuration["ASPNETCORE_URLS"] ?? configuration["Urls"];
-        var healthUrl = "http://localhost:8080/health";
-
-        if (!string.IsNullOrWhiteSpace(urls))
-        {
-            string firstUrl = urls.Split(';').FirstOrDefault(s => s.Contains("http://"))!
-                .Replace("*", "localhost").Replace("+", "localhost");
-
-            healthUrl = $"{firstUrl.TrimEnd('/')}/health";
-        }
-
-        services.AddHealthChecksUI(setup =>
-        {
-            setup.SetNotifyUnHealthyOneTimeUntilChange();
-            setup.AddHealthCheckEndpoint("primary, heal", healthUrl);
-            setup.SetHeaderText("Midrand Books");
-        })
-        .AddInMemoryStorage();
-
-        services.AddOutputCache(options =>
-        {
-            options.AddBasePolicy(builder => builder.Cache());
-            options.DefaultExpirationTimeSpan = TimeSpan.FromSeconds(10);
-        });
-
-        services.AddOpenApi(options => options.AddDocumentTransformer<OpenApiBearerSecuritySchemeTransformer>());
-
-        return services;
-    }
-}

MidrandBooksApi/appsettings.json

@@ -1,4 +1,17 @@
 {
+  "LiteCharmsSettings": { 
+    "Authority": "https://sts.security.khongisa.co.za",
+    "Audience": "midrandbooks-api"
+  },
+  "ValidPayfastHosts": [
+    "www.payfast.co.za",
+    "sandbox.payfast.co.za",
+    "w1w.payfast.co.za",
+    "w2w.payfast.co.za",
+    "ips.payfast.co.za",
+    "api.payfast.co.za",
+    "payment.payfast.io"
+  ],
   "HasherSettings": {
     "MinHashLength": 11
   },

midrandbooksapi-uat.yml

@@ -19,6 +19,15 @@ data:
   BookshopS3Settings__Region: "garage"
   BookshopS3Settings__BucketName: "bookshop"
   BookshopS3Settings__CdnBaseUrl: "https://bookshop.cdn.khongisa.co.za"
+  ValidPayfastHosts__0: "www.payfast.co.za"
+  ValidPayfastHosts__1: "sandbox.payfast.co.za"
+  ValidPayfastHosts__2: "w1w.payfast.co.za"
+  ValidPayfastHosts__3: "w2w.payfast.co.za"
+  ValidPayfastHosts__4: "ips.payfast.co.za"
+  ValidPayfastHosts__5: "api.payfast.co.za"
+  ValidPayfastHosts__6: "payment.payfast.io"
+  LiteCharmsSettings__Authority: "https://sts.security.khongisa.co.za"
+  LiteCharmsSettings__Audience: "midrandbooks-api"
 ---
 apiVersion: v1
 kind: Secret
@@ -34,6 +43,8 @@ data:
   hasher-payfastpassphrase: OUdBSVIwdFdwaFgwcU8=
   bookshop-s3-accesskey: R0s1MTRkMmNlOGRjNjkyMzdhMDVjMDFlZWY=
   bookshop-s3-secretkey: ZWFhZmVkYTFhZWQ0MDllY2ZlNjA3MTRlY2RhNTQ5YjgyYmRmNWEzZGFmOWYxOGRkNjFmNjZiNDk3M2E2NDgyZQ==
+  litecharms-clientid: bWlkcmFuZGJvb2tzLWFwaQ==
+  litecharms-clientsecret: c2VjcmV0X2YzZjA0YWNhYTMzNmVlOTEzZDRjNjdlYmQwOTE1ZWFlYzQ0NzdmYTkwOTdlYTJhYzkyZGE4ZDc0NjgzZTAyNTU=
 ---
 apiVersion: v1
 kind: PersistentVolumeClaim
@@ -86,6 +97,16 @@ spec:
             - configMapRef:
                 name: midrandbooksapi-config
           env:
+            - name: LiteCharmsSettings__ClientId
+              valueFrom:
+                secretKeyRef:
+                  name: midrandbooksapi-secrets
+                  key: litecharms-clientid
+            - name: LiteCharmsSettings__ClientSecret
+              valueFrom:
+                secretKeyRef:
+                  name: midrandbooksapi-secrets
+                  key: litecharms-clientsecret
             - name: BookshopS3Settings__AccessKey
               valueFrom:
                 secretKeyRef: