Improve some logs and allow disabling of signing

Danielku15 · Jan 12, 2024 · 786df2b · 786df2b
1 parent 08de130
commit 786df2b
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 4 deletions.
diff --git a/SigningServer.Client/Program.cs b/SigningServer.Client/Program.cs
@@ -2,6 +2,7 @@
 using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Configuration.EnvironmentVariables;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
@@ -31,6 +32,11 @@ private static async Task Main(string[] args)
             })
             .ConfigureAppConfiguration(config =>
             {
+                foreach (var envSources in config.Sources.OfType<EnvironmentVariablesConfigurationSource>().ToArray())
+                {
+                    config.Sources.Remove(envSources);
+                }
+                config.AddEnvironmentVariables("SIGNINGSERVER_CLIENT_");
                 config.AddJsonFile("config.json", optional: true);
             })
             .ConfigureServices(services =>

diff --git a/SigningServer.Client/SigningClientConfiguration.cs b/SigningServer.Client/SigningClientConfiguration.cs
@@ -14,6 +14,8 @@ public class SigningClientConfiguration : SigningClientConfigurationBase
     /// </summary>
     public string SigningServer { get; set; } = string.Empty;
 
+    public override string CredentialInfo => Username;
+
     /// <summary>
     /// The username for authentication and cerificate selection.
     /// </summary>

diff --git a/SigningServer.ClientCore/SigningClient.cs b/SigningServer.ClientCore/SigningClient.cs
@@ -131,7 +131,7 @@ await File.WriteAllBytesAsync(Configuration.LoadCertificatePath!,
                 var error = $"Certificate Loading Failed with error '{responseDto.ErrorMessage}'";
                 throw new SigningFailedException(error);
             case LoadCertificateResponseStatus.CertificateNotLoadedUnauthorized:
-                Logger.LogError("The specified username and password are not recognized on the server");
+                Logger.LogError("The specified username and password are not recognized on the server ({Status}, {Username})", responseDto.Status, Configuration.CredentialInfo);
                 throw new UnauthorizedAccessException();
             default:
                 throw new ArgumentOutOfRangeException();
@@ -194,7 +194,7 @@ await File.WriteAllBytesAsync(signatureFile, Convert.FromBase64String(responseDt
                             $"Signing Failed with error '{responseDto.ErrorMessage}' (sign time: {responseDto.SignTimeInMilliseconds:0}ms)";
                         throw new SigningFailedException(error);
                     case SignHashResponseStatus.HashNotSignedUnauthorized:
-                        Logger.LogError("The specified username and password are not recognized on the server");
+                        Logger.LogError("The specified username and password are not recognized on the server ({Status}, {Username})", responseDto.Status, Configuration.CredentialInfo);
                         throw new UnauthorizedAccessException();
                     default:
                         throw new ArgumentOutOfRangeException();
@@ -341,7 +341,7 @@ void WriteResponseInfo()
                                 $"Signing Failed with error '{errorMessage}' (upload time: {uploadTime.TotalMilliseconds:0}ms, sign time: {signTime.TotalMilliseconds:0}ms)";
                             throw new SigningFailedException(error);
                         case SignFileResponseStatus.FileNotSignedUnauthorized:
-                            Logger.LogError("The specified username and password are not recognized on the server");
+                            Logger.LogError("The specified username and password are not recognized on the server ({Status}, {Username})", status, Configuration.CredentialInfo);
                             throw new UnauthorizedAccessException();
                         default:
                             throw new ArgumentOutOfRangeException();

diff --git a/SigningServer.ClientCore/SigningClientConfiguration.cs b/SigningServer.ClientCore/SigningClientConfiguration.cs
@@ -11,8 +11,18 @@ namespace SigningServer.ClientCore;
 /// <summary>
 /// Represents the signing client 
 /// </summary>
-public class SigningClientConfigurationBase
+public abstract class SigningClientConfigurationBase
 {
+    /// <summary>
+    /// Whether to execute signing or not, useful if you have to enable/disable signing temporarily.
+    /// </summary>
+    public bool IsSigningDisabled { get; set; }
+
+    /// <summary>
+    /// Gets the credential info to use for authentication and certificate selection.
+    /// </summary>
+    public abstract string CredentialInfo { get; }
+
     /// <summary>
     /// Whether to overwrite existing signatures or fail when signatures are present.
     /// </summary>

diff --git a/SigningServer.ClientCore/SigningClientRunner.cs b/SigningServer.ClientCore/SigningClientRunner.cs
@@ -37,6 +37,12 @@ public async Task RunAsync()
             return;
         }
 
+        if (configuration.IsSigningDisabled)
+        {
+            _logger.LogWarning("Signing was disabled by configuration");
+            return;
+        }
+
         foreach (var source in configuration.Sources)
         {
             if (!File.Exists(source) && !Directory.Exists(source))

diff --git a/SigningServer.StandaloneClient/Program.cs b/SigningServer.StandaloneClient/Program.cs
@@ -2,6 +2,7 @@
 using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Configuration.EnvironmentVariables;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
@@ -32,6 +33,11 @@ private static async Task Main(string[] args)
             })
             .ConfigureAppConfiguration(config =>
             {
+                foreach (var envSources in config.Sources.OfType<EnvironmentVariablesConfigurationSource>().ToArray())
+                {
+                    config.Sources.Remove(envSources);
+                }
+                config.AddEnvironmentVariables("SIGNINGSERVER_CLIENT_");
                 config.AddJsonFile("config.json", optional: true);
             })
             .ConfigureServices(services =>

diff --git a/SigningServer.StandaloneClient/StandaloneSigningClientConfiguration.cs b/SigningServer.StandaloneClient/StandaloneSigningClientConfiguration.cs
@@ -21,6 +21,8 @@ public class StandaloneSigningClientConfiguration : SigningClientConfigurationBa
 {
     public ServerType ServerType { get; set; }
 
+    public override string CredentialInfo => "local";
+
     /// <summary>
     /// A RFC-3161 compliant timestamping server which should be used.
     /// </summary>