[BEEEP] [PM-2844] Add custom error codes for server API exceptions

src/Api/Utilities/ExceptionHandlerFilterAttribute.cs

@@ -1,7 +1,9 @@
 using System.Text;
 using Bit.Api.Models.Public.Response;
 using Bit.Core.Billing;
+using Bit.Core.Enums;
 using Bit.Core.Exceptions;
+using Bit.Core.Services;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
 using Microsoft.IdentityModel.Tokens;
@@ -21,7 +23,7 @@ public ExceptionHandlerFilterAttribute(bool publicApi)
 
     public override void OnException(ExceptionContext context)
     {
-        var errorMessage = "An error has occurred.";
+        var errorMessage = GetFormattedMessageFromErrorCode(context);
 
         var exception = context.Exception;
         if (exception == null)
@@ -46,10 +48,6 @@ public override void OnException(ExceptionContext context)
                     internalErrorModel = new InternalApi.ErrorResponseModel(badRequestException.ModelState);
                 }
             }
-            else
-            {
-                errorMessage = badRequestException.Message;
-            }
         }
         else if (exception is StripeException { StripeError.Type: "card_error" } stripeCardErrorException)
         {
@@ -67,7 +65,6 @@ public override void OnException(ExceptionContext context)
         }
         else if (exception is GatewayException)
         {
-            errorMessage = exception.Message;
             context.HttpContext.Response.StatusCode = 400;
         }
         else if (exception is BillingException billingException)
@@ -106,7 +103,6 @@ public override void OnException(ExceptionContext context)
         }
         else if (exception is NotSupportedException && !string.IsNullOrWhiteSpace(exception.Message))
         {
-            errorMessage = exception.Message;
             context.HttpContext.Response.StatusCode = 400;
         }
         else if (exception is ApplicationException)
@@ -115,17 +111,17 @@ public override void OnException(ExceptionContext context)
         }
         else if (exception is NotFoundException)
         {
-            errorMessage = "Resource not found.";
+            errorMessage = GetFormattedMessageFromErrorCode(context, ErrorCode.CommonResourceNotFound);
             context.HttpContext.Response.StatusCode = 404;
         }
         else if (exception is SecurityTokenValidationException)
         {
-            errorMessage = "Invalid token.";
+            errorMessage = GetFormattedMessageFromErrorCode(context, ErrorCode.CommonInvalidToken);
             context.HttpContext.Response.StatusCode = 403;
         }
         else if (exception is UnauthorizedAccessException)
         {
-            errorMessage = "Unauthorized.";
+            errorMessage = GetFormattedMessageFromErrorCode(context, ErrorCode.CommonUnauthorized);
             context.HttpContext.Response.StatusCode = 401;
         }
         else if (exception is ConflictException)
@@ -150,7 +146,7 @@ public override void OnException(ExceptionContext context)
         {
             var logger = context.HttpContext.RequestServices.GetRequiredService<ILogger<ExceptionHandlerFilterAttribute>>();
             logger.LogError(0, exception, exception.Message);
-            errorMessage = "An unhandled server error has occurred.";
+            errorMessage = GetFormattedMessageFromErrorCode(context, ErrorCode.CommonUnhandledError);
             context.HttpContext.Response.StatusCode = 500;
         }
 
@@ -172,4 +168,11 @@ public override void OnException(ExceptionContext context)
             context.Result = new ObjectResult(errorModel);
         }
     }
+
+    private string GetFormattedMessageFromErrorCode(ExceptionContext context, ErrorCode? alternativeErrorCode = null)
+    {
+        var errorMessageService = context.HttpContext.RequestServices.GetRequiredService<IErrorMessageService>();
+
+        return errorMessageService.GetErrorMessage(context.Exception, alternativeErrorCode);
+    }
 }

src/Api/Vault/Controllers/SyncController.cs

@@ -71,7 +71,7 @@ public async Task<SyncResponseModel> Get([FromQuery] bool excludeDomains = false
         var user = await _userService.GetUserByPrincipalAsync(User);
         if (user == null)
         {
-            throw new BadRequestException("User not found.");
+            throw new BadRequestException(ErrorCode.CommonUserNotFound);
         }
 
         var organizationUserDetails = await _organizationUserRepository.GetManyDetailsByUserAsync(user.Id,

src/Core/Core.csproj

@@ -17,6 +17,14 @@
     <EmbeddedResource Include="licensing.cer" />
     <EmbeddedResource Include="licensing_dev.cer" />
     <EmbeddedResource Include="MailTemplates\Handlebars\**\*.hbs" />
+    <EmbeddedResource Update="Resources\ErrorMessages.resx">
+      <Generator>ResXFileCodeGenerator</Generator>
+      <LastGenOutput>ErrorMessages.Designer.cs</LastGenOutput>
+    </EmbeddedResource>
+    <EmbeddedResource Update="Resources\ErrorMessages.pt.resx">
+      <Generator>ResXFileCodeGenerator</Generator>
+      <LastGenOutput>ErrorMessages.pt.Designer.cs</LastGenOutput>
+    </EmbeddedResource>
   </ItemGroup>
 
   <ItemGroup>
@@ -63,7 +71,19 @@
   </ItemGroup>
 
   <ItemGroup>
-    <Folder Include="Resources\" />
     <Folder Include="Properties\" />
   </ItemGroup>
+
+  <ItemGroup>
+    <Compile Update="Resources\ErrorMessages.Designer.cs">
+      <DesignTime>True</DesignTime>
+      <AutoGen>True</AutoGen>
+      <DependentUpon>ErrorMessages.resx</DependentUpon>
+    </Compile>
+    <Compile Update="Resources\ErrorMessages.pt.Designer.cs">
+      <DesignTime>True</DesignTime>
+      <AutoGen>True</AutoGen>
+      <DependentUpon>ErrorMessages.pt.resx</DependentUpon>
+    </Compile>
+  </ItemGroup>
 </Project>

src/Core/Enums/ErrorCode.cs

@@ -0,0 +1,26 @@
+namespace Bit.Core.Enums;
+
+public enum ErrorCode
+{
+    // Common errors (0000-0999)
+    CommonError = 0000,
+    CommonUserNotFound = 0001,
+    CommonOrganizationNotFound = 0002,
+    CommonUnauthorized = 0401,
+    CommonInvalidToken = 0403,
+    CommonResourceNotFound = 0404,
+    CommonUnhandledError = 0500,
+
+    // Identity errors (1000-1999)
+    IdentityInvalidUsernameOrPassword = 1001,
+    IdentitySsoRequired = 1002,
+    IdentityEncryptionKeyMigrationRequired = 1003
+}
+
+public static class ErrorCodeExtensions
+{
+    public static string ToErrorCodeString(this ErrorCode code)
+    {
+        return ((int)code).ToString("D4"); // Formats to 4 digits with leading zeros
+    }
+}

src/Core/Exceptions/BadRequestException.cs

@@ -1,4 +1,5 @@
-using Microsoft.AspNetCore.Mvc.ModelBinding;
+using Bit.Core.Enums;
+using Microsoft.AspNetCore.Mvc.ModelBinding;
 
 namespace Bit.Core.Exceptions;
 
@@ -11,6 +12,10 @@ public BadRequestException(string message)
         : base(message)
     { }
 
+    public BadRequestException(ErrorCode errorCode)
+        : base(errorCode.ToErrorCodeString())
+    { }
+
     public BadRequestException(string key, string errorMessage)
         : base("The model state is invalid.")
     {

src/Core/Resources/ErrorMessages.pt.resx

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<root>
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:element name="root" msdata:IsDataSet="true">
+
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>1.3</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <data name="0000" xml:space="preserve">
+    <value>Ocorreu um erro.</value>
+  </data>
+  <data name="0002" xml:space="preserve">
+    <value>Organização não encontrada.</value>
+  </data>
+  <data name="0001" xml:space="preserve">
+    <value>Utilizador não encontrado.</value>
+  </data>
+  <data name="0404" xml:space="preserve">
+    <value>Recurso não encontrado.</value>
+  </data>
+  <data name="0403" xml:space="preserve">
+    <value>Token inválido.</value>
+  </data>
+  <data name="0401" xml:space="preserve">
+    <value>Não autorizado.</value>
+  </data>
+  <data name="0500" xml:space="preserve">
+    <value>Ocorreu um erro não tratado no servidor.</value>
+  </data>
+  <data name="1001" xml:space="preserve">
+    <value>Nome de utilizador ou palavra-passe incorretos. Tente novamente.</value>
+  </data>
+  <data name="1003" xml:space="preserve">
+    <value>Encryption key migration is required. Please log in to the web vault at</value>
+  </data>
+</root>

src/Core/Resources/ErrorMessages.resx

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<root>
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:element name="root" msdata:IsDataSet="true">
+
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>1.3</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <data name="0000" xml:space="preserve">
+    <value>An error has occurred.</value>
+  </data>
+  <data name="0001" xml:space="preserve">
+    <value>User not found.</value>
+  </data>
+  <data name="0002" xml:space="preserve">
+    <value>Organization not found.</value>
+  </data>
+  <data name="0403" xml:space="preserve">
+    <value>Invalid token.</value>
+  </data>
+  <data name="0401" xml:space="preserve">
+    <value>Unauthorized.</value>
+  </data>
+  <data name="0404" xml:space="preserve">
+    <value>Resource not found.</value>
+  </data>
+  <data name="0500" xml:space="preserve">
+    <value>An unhandled server error has occurred.</value>
+  </data>
+  <data name="1003" xml:space="preserve">
+    <value>Encryption key migration is required. Please log in to the web vault at</value>
+  </data>
+  <data name="1001" xml:space="preserve">
+    <value>Username or password is incorrect. Try again.</value>
+  </data>
+</root>

src/Core/Services/IErrorMessageService.cs

@@ -0,0 +1,9 @@
+using Bit.Core.Enums;
+
+namespace Bit.Core.Services;
+
+public interface IErrorMessageService
+{
+    string GetErrorMessage(ErrorCode errorCode);
+    string GetErrorMessage(Exception exception, ErrorCode? alternativeErrorCode = null);
+}