API: provide login invalid credentials problemdetails

Author: webprofusion-chrisc

src/Certify.Models/Util/ProblemDetails.cs

@@ -0,0 +1,76 @@
+using System;
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+namespace Certify.Models.Util
+{
+    // extracted from the following to avoid including MVC dependencies
+    //https://github.com/dotnet/aspnetcore/blob/main/src/Http/Http.Abstractions/src/ProblemDetails/ProblemDetails.cs
+    // Licensed to the .NET Foundation under one or more agreements.
+    // The .NET Foundation licenses this file to you under the MIT license.
+
+    /// <summary>
+    /// A machine-readable format for specifying errors in HTTP API responses based on <see href="https://tools.ietf.org/html/rfc7807"/>.
+    /// </summary>
+    public class ProblemDetails
+    {
+        /// <summary>
+        /// A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when
+        /// dereferenced, it provide human-readable documentation for the problem type
+        /// (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be
+        /// "about:blank".
+        /// </summary>
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        [JsonPropertyOrder(-5)]
+        [JsonPropertyName("type")]
+        public string? Type { get; set; }
+
+        /// <summary>
+        /// A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence
+        /// of the problem, except for purposes of localization(e.g., using proactive content negotiation;
+        /// see[RFC7231], Section 3.4).
+        /// </summary>
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        [JsonPropertyOrder(-4)]
+        [JsonPropertyName("title")]
+        public string? Title { get; set; }
+
+        /// <summary>
+        /// The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
+        /// </summary>
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        [JsonPropertyOrder(-3)]
+        [JsonPropertyName("status")]
+        public int? Status { get; set; }
+
+        /// <summary>
+        /// A human-readable explanation specific to this occurrence of the problem.
+        /// </summary>
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        [JsonPropertyOrder(-2)]
+        [JsonPropertyName("detail")]
+        public string? Detail { get; set; }
+
+        /// <summary>
+        /// A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
+        /// </summary>
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        [JsonPropertyOrder(-1)]
+        [JsonPropertyName("instance")]
+        public string? Instance { get; set; }
+
+        /// <summary>
+        /// Gets the <see cref="IDictionary{TKey, TValue}"/> for extension members.
+        /// <para>
+        /// Problem type definitions MAY extend the problem details object with additional members. Extension members appear in the same namespace as
+        /// other members of a problem type.
+        /// </para>
+        /// </summary>
+        /// <remarks>
+        /// The round-tripping behavior for <see cref="Extensions"/> is determined by the implementation of the Input \ Output formatters.
+        /// In particular, complex types or collection types may not round-trip to the original type when using the built-in JSON or XML formatters.
+        /// </remarks>
+        [JsonExtensionData]
+        public IDictionary<string, object?> Extensions { get; set; } = new Dictionary<string, object?>(StringComparer.Ordinal);
+    }
+}

src/Certify.Server/Certify.Server.Hub.Api.Client/Certify.Server.Hub.Api.Client.cs

@@ -12,6 +12,7 @@
 using Certify.Models.Hub;
 using Certify.Models.Config.Migration;
 using Certify.Shared;
+using ProblemDetails=Certify.Models.Util.ProblemDetails;
 
 #pragma warning disable 108 // Disable "CS0108 '{derivedDto}.ToJson()' hides inherited member '{dtoBase}.ToJson()'. Use the new keyword if hiding was intended."
 #pragma warning disable 114 // Disable "CS0114 '{derivedDto}.RaisePropertyChanged(String)' hides inherited member 'dtoBase.RaisePropertyChanged(String)'. To make the current member override that implementation, add the override keyword. Otherwise add the new keyword."
@@ -1456,6 +1457,16 @@ public virtual async System.Threading.Tasks.Task<AuthResponse> LoginAsync(AuthRe
                             return objectResponse_.Object;
                         }
                         else
+                        if (status_ == 401)
+                        {
+                            var objectResponse_ = await ReadObjectResponseAsync<ProblemDetails>(response_, headers_, cancellationToken).ConfigureAwait(false);
+                            if (objectResponse_.Object == null)
+                            {
+                                throw new ApiException("Response was null which was not expected.", status_, objectResponse_.Text, headers_, null);
+                            }
+                            throw new ApiException<ProblemDetails>("Unauthorized", status_, objectResponse_.Text, headers_, objectResponse_.Object, null);
+                        }
+                        else
                         {
                             var responseData_ = response_.Content == null ? null : await response_.Content.ReadAsStringAsync().ConfigureAwait(false);
                             throw new ApiException("The HTTP status code of the response was not expected (" + status_ + ").", status_, responseData_, headers_, null);

src/Certify.Server/Certify.Server.Hub.Api.Client/nswag.json

@@ -54,7 +54,8 @@
         "Certify.Models.Providers",
         "Certify.Models.Hub",
         "Certify.Models.Config.Migration",
-        "Certify.Shared"
+        "Certify.Shared",
+        "ProblemDetails=Certify.Models.Util.ProblemDetails"
       ],
       "additionalContractNamespaceUsages": [],
       "generateOptionalParameters": false,

src/Certify.Server/Certify.Server.Hub.Api/Controllers/v1/AuthController.cs

@@ -51,7 +51,8 @@ public async Task<IActionResult> CheckAuthStatus()
         /// <returns>Response contains access token and refresh token for API operations.</returns>
         [HttpPost]
         [Route("login")]
-        [ProducesResponseType(typeof(AuthResponse), 200)]
+        [ProducesResponseType(typeof(AuthResponse), StatusCodes.Status200OK)]
+        [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status401Unauthorized)]
         public async Task<IActionResult> Login(AuthRequest login)
         {
 
@@ -79,7 +80,7 @@ public async Task<IActionResult> Login(AuthRequest login)
             }
             else
             {
-                return Unauthorized();
+                return Unauthorized(new ProblemDetails { Status = StatusCodes.Status401Unauthorized, Title = "Invalid username or password" });
             }
         }
 
@@ -91,7 +92,7 @@ public async Task<IActionResult> Login(AuthRequest login)
         [Authorize(AuthenticationSchemes = JwtBearerDefaults.AuthenticationScheme)]
         [HttpPost]
         [Route("refresh")]
-        [ProducesResponseType(typeof(AuthResponse), 200)]
+        [ProducesResponseType(typeof(AuthResponse), StatusCodes.Status200OK)]
         public async Task<IActionResult> Refresh(string refreshToken)
         {
             var authToken = AuthenticationHeaderValue.Parse(Request.Headers["Authorization"]!).Parameter;