[SignCheck] Output results to an xml file (#15591)

Author: ellahathaway

src/Microsoft.DotNet.Arcade.Sdk/tools/SdkTasks/SigningValidation.proj

@@ -32,6 +32,7 @@
       <SignCheckInputDir>$(PackageBasePath)</SignCheckInputDir>
       <SignCheckLog Condition="'$(SignCheckLog)' == ''">$(ArtifactsLogDir)\signcheck.log</SignCheckLog>
       <SignCheckErrorLog Condition="'$(SignCheckErrorLog)' == ''">$(ArtifactsLogDir)\signcheck.errors.log</SignCheckErrorLog>
+      <SignCheckResultsXmlFile Condition="'$(SignCheckResultsXmlFile)' == ''">$(ArtifactsLogDir)\signcheck.xml</SignCheckResultsXmlFile>
       <InputFiles Condition="'$(BuildManifestFile)' == ''">$(SignCheckInputDir)</InputFiles>
       <InputFiles Condition="'$(BuildManifestFile)' != ''">@(ItemsToSign)</InputFiles>
     </PropertyGroup>
@@ -50,6 +51,7 @@
       VerifyStrongName="$(EnableStrongNameCheck)"
       LogFile="$(SignCheckLog)"
       ErrorLogFile="$(SignCheckErrorLog)"
+      ResultsXmlFile="$(SignCheckResultsXmlFile)"
       ArtifactFolder="$(SignCheckInputDir)"/>
 
     <Error 

src/SignCheck/Microsoft.SignCheck/Logging/ConsoleLogger.cs

@@ -58,6 +58,16 @@ public void WriteError(LogVerbosity verbosity, string message, params object[] v
             }
         }
 
+        public void WriteStartResult(string fileName, string resultType, string error = null)
+        {
+            throw new NotImplementedException("ConsoleLogger does not support WriteStartResult.");
+        }
+
+        public void WriteEndResult()
+        {
+            throw new NotImplementedException("ConsoleLogger does not support WriteEndResult.");
+        }
+
         public void WriteLine()
         {
             Console.WriteLine();

src/SignCheck/Microsoft.SignCheck/Logging/FileLogger.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.IO;
+using System.Xml;
 
 namespace Microsoft.SignCheck.Logging
 {
@@ -20,13 +21,19 @@ internal StreamWriter MessageWriter
             set;
         }
 
+        internal XmlWriter ResultsWriter
+        {
+            get;
+            set;
+        }
+
         internal long Lines
         {
             get;
             set;
         }
 
-        public FileLogger(LogVerbosity verbosity, string messageFile, string errorFile) : base(verbosity)
+        public FileLogger(LogVerbosity verbosity, string messageFile, string errorFile, string resultsFile) : base(verbosity)
         {
             if (!String.IsNullOrEmpty(messageFile))
             {
@@ -47,6 +54,22 @@ public FileLogger(LogVerbosity verbosity, string messageFile, string errorFile)
                 ErrorWriter.AutoFlush = true;
             }
 
+            if (!String.IsNullOrEmpty(resultsFile))
+            {
+                if (!Directory.Exists(resultsFile))
+                {
+                    Directory.CreateDirectory(Path.GetDirectoryName(Path.GetFullPath(resultsFile)));
+                }
+                ResultsWriter = XmlWriter.Create(resultsFile, new XmlWriterSettings()
+                {
+                    Indent = true,
+                    IndentChars = "\t",
+                    OmitXmlDeclaration = true
+                });
+                ResultsWriter.WriteStartDocument();
+                ResultsWriter.WriteStartElement("SignCheckResults");
+            }
+
             Lines = 0;
         }
 
@@ -63,6 +86,12 @@ public override void Close()
                 ErrorWriter.Flush();
                 ErrorWriter.Close();
             }
+
+            if (ResultsWriter != null)
+            {
+                ResultsWriter.WriteEndElement();
+                ResultsWriter.Close();
+            }
         }
 
         public void WriteMessage(string message)
@@ -134,5 +163,27 @@ public void WriteLine()
                 }
             }
         }
+
+        public void WriteStartResult(string fileName, string resultType, string error = null)
+        {
+            if (ResultsWriter != null)
+            {
+                ResultsWriter.WriteStartElement("File");
+                ResultsWriter.WriteAttributeString("Name", fileName);
+                ResultsWriter.WriteAttributeString("ResultType", resultType);
+                if (!String.IsNullOrEmpty(error))
+                {
+                    ResultsWriter.WriteAttributeString("Error", error);
+                }
+            }
+        }
+
+        public void WriteEndResult()
+        {
+            if (ResultsWriter != null)
+            {
+                ResultsWriter.WriteEndElement();
+            }
+        }
     }
 }

src/SignCheck/Microsoft.SignCheck/Logging/ILogger.cs

@@ -25,5 +25,9 @@ bool HasLoggedErrors
         void WriteError(LogVerbosity verbosity, string message);
 
         void WriteError(LogVerbosity verbosity, string message, params object[] values);
+
+        void WriteStartResult(string fileName, string resultType, string error = null);
+
+        void WriteEndResult();
     }
 }

src/SignCheck/Microsoft.SignCheck/Logging/Log.cs

@@ -24,10 +24,10 @@ public LogVerbosity Verbosity
             private set;
         }
 
-        public Log(string logFile, string errorFile, LogVerbosity verbosity)
+        public Log(string logFile, string errorFile, string resultsFile, LogVerbosity verbosity)
         {
             _loggers = new List<ILogger>();
-            Add(new FileLogger(verbosity, logFile, errorFile));
+            Add(new FileLogger(verbosity, logFile, errorFile, resultsFile));
             Add(new ConsoleLogger(verbosity));
             Verbosity = verbosity;
         }
@@ -72,6 +72,16 @@ public void WriteLine()
             _loggers.ForEach(p => p.WriteLine());
         }
 
+        public void WriteStartResult(string fileName, string resultType, string error = null)
+        {
+            _loggers.OfType<FileLogger>().FirstOrDefault().WriteStartResult(fileName, resultType, error);
+        }
+
+        public void WriteEndResult()
+        {
+            _loggers.OfType<FileLogger>().FirstOrDefault().WriteEndResult();
+        }
+
         public void Close()
         {
             _loggers.ForEach(p => p.Close());

src/SignCheck/Microsoft.SignCheck/Verification/SignatureVerificationResult.cs

@@ -260,6 +260,19 @@ public string ToString(string[] detailKeys)
             return sb.ToString();
         }
 
+        /// <summary>
+        /// </summary>
+        /// <param name="detailKey"></param>
+        /// <returns></returns>
+        public string ToString(string detailKey)
+        {
+            if (Detail.TryGetValue(detailKey, out string value))
+            {
+                return value;
+            }
+            return String.Empty;
+        }
+
         /// <summary>
         /// Creates a SignatureVerificationResult for an unsupported file type or file extension.
         /// </summary>

src/SignCheck/SignCheckTask/src/Options.cs

@@ -58,6 +58,14 @@ public string LogFile
             set;
         }
 
+        [Option("results-xml-file",
+            HelpText = "Output signing results to the specified XML log file. If the file already exists it will be overwritten.")]
+        public string ResultsXmlFile
+        {
+            get;
+            set;
+        }
+
         [Option('m', "verify-xml",
             HelpText = "Enable XML signature verification. By default, .xml files are not verified.")]
         public bool EnableXmlSignatureVerification

src/SignCheck/SignCheckTask/src/SignCheck.cs

@@ -135,7 +135,7 @@ private void HandleOptions(Options options)
         {
             Options = options;
 
-            Log = new Log(options.LogFile, options.ErrorLogFile, options.Verbosity);
+            Log = new Log(options.LogFile, options.ErrorLogFile, options.ResultsXmlFile, options.Verbosity);
 
             if (Options.FileStatus.Count() > 0)
             {
@@ -308,29 +308,35 @@ private void ProcessResults(IEnumerable<SignatureVerificationResult> results, in
             foreach (SignatureVerificationResult result in results)
             {
                 TotalFiles++;
+                string resultType = "Unknown";
 
                 if (result.IsSigned && !result.IsExcluded)
                 {
                     TotalSignedFiles++;
+                    resultType = "Signed";
                 }
                 else if (!(result.IsExcluded || result.IsSkipped) && (!result.IsSigned && !result.IsDoNotSign))
                 {
                     TotalUnsignedFiles++;
+                    resultType = "Unsigned";
                 }
 
                 if (result.IsExcluded || (!result.IsSigned && result.IsDoNotSign))
                 {
                     TotalExcludedFiles++;
+                    resultType = "Excluded";
                 }
 
                 if (result.IsSkipped)
                 {
                     TotalSkippedFiles++;
+                    resultType = "Skipped";
                 }
 
                 if (result.IsSkipped && result.IsExcluded)
                 {
                     TotalSkippedExcludedFiles++;
+                    resultType = "SkippedExcluded";
                 }
 
                 // Regardless of the file status reporting settings, a container file like an MSI or NuGet package
@@ -352,10 +358,12 @@ private void ProcessResults(IEnumerable<SignatureVerificationResult> results, in
                     NoSignIssues = false;
                 }
 
+                Log.WriteStartResult(result.VirtualPath, resultType, result.ToString(DetailKeys.Error));
                 if (result.NestedResults.Count > 0)
                 {
                     ProcessResults(result.NestedResults, indent + 2);
                 }
+                Log.WriteEndResult();
             }
         }
 

src/SignCheck/SignCheckTask/src/SignCheckTask.cs

@@ -86,6 +86,11 @@ public string ErrorLogFile
             get;
             set;
         }
+        public string ResultsXmlFile
+        {
+            get;
+            set;
+        }
         public string Verbosity
         {
             get;
@@ -130,6 +135,7 @@ private bool ExecuteImpl()
             options.VerifyStrongName = VerifyStrongName;
             options.LogFile = LogFile;
             options.ErrorLogFile = ErrorLogFile;
+            options.ResultsXmlFile = ResultsXmlFile;
 
             List<string> inputFiles = new List<string>();
             if (InputFiles != null)