检查pdb文件是否与源匹配

时间:2016-04-15 14:01:20

标签: c# pdb debug-symbols

我想写一下检查证明给定程序集附近有有效的pdb文件,并且存储在pdb中的校验和与源校验和匹配。

在我们的CI服务器上,该检查曾被称为单元测试,以防止在构建服务器配置被破坏时发布二进制文件(例如,使用不同的git分支来构建代码)。

如果可能,它应接受MethodInfo作为输入参数。我想仔细检查并验证方法的源行是估计的。

第一部分,阅读特定方法的来源非常简单。这是a sample

困难的部分是检查PDB中所有文档的校验和。标准System.Diagnostics.SymbolStore.SymDocument.GetCheckSum()抛出NotImplementedException所以我肯定需要使用别的东西。

有什么建议吗?

UPD。试图澄清:)

  1. 我有兴趣检查源文件的校验和是否与PDB文件中存储的校验和匹配,第一部分(检查pdb是否匹配二进制文件)已经完成。

  2. 我正在为此任务寻找一些API,因为我不想解析控制台输出。此外,我不希望在我们的CI服务器上安装任何其他SDK,因为它需要额外的时间来证明没有任何内容被破坏。

3 个答案:

答案 0 :(得分:5)

如果您需要以编程方式执行此操作,则可以使用Microsoft.DiaSymReaderPackage(版本1.0.7.0),并且还需要声明其他几个非托管接口。使用以下两种算法之一从文件字节中轻松计算校验和:SHA1或MD5。

以下是一个示例控制台应用程序,它显示有关其自身来源的信息:

  class Program
  {
      static void Main(string[] args)
      {
          ValidateChecksums(Path.GetFullPath("ConsoleApplication1.exe"));
      }

      // this needs a reference to Microsoft.DiaSymReader
      // or redefine its interfaces manually from here https://github.com/dotnet/roslyn/tree/master/src/Dependencies/Microsoft.DiaSymReader
      public static void ValidateChecksums(string filePath)
      {
          if (filePath == null)
              throw new ArgumentNullException(nameof(filePath));

          var dispenser = (IMetaDataDispenser)new CorMetaDataDispenser();
          var import = dispenser.OpenScope(filePath, 0, typeof(IMetaDataImport).GUID);

          var binder = (ISymUnmanagedBinder)new CorSymBinder_SxS();
          ISymUnmanagedReader reader;
          binder.GetReaderForFile(import, filePath, null, out reader);

          int count;
          reader.GetDocuments(0, out count, null);
          if (count > 0)
          {
              var docs = new ISymUnmanagedDocument[count];
              reader.GetDocuments(count, out count, docs);
              foreach (var d in docs)
              {
                  var doc = new SymDocument(d);
                  Console.WriteLine(doc.Url);

                  if (doc.Checksum.SequenceEqual(doc.ComputeChecksum()))
                  {
                      Console.WriteLine(" checksum is valid.");
                  }
                  else
                  {
                      Console.WriteLine(" checksum is not valid.");
                  }
              }
          }
      }
  }

示例助手类,本机接口和coclass。

  public class SymDocument
  {
      // guids are from corsym.h
      public static readonly Guid CorSym_SourceHash_MD5 = new Guid(0x406ea660, 0x64cf, 0x4c82, 0xb6, 0xf0, 0x42, 0xd4, 0x81, 0x72, 0xa7, 0x99);
      public static readonly Guid CorSym_SourceHash_SHA1 = new Guid(0xff1816ec, 0xaa5e, 0x4d10, 0x87, 0xf7, 0x6f, 0x49, 0x63, 0x83, 0x34, 0x60);

      public SymDocument(ISymUnmanagedDocument doc)
      {
          if (doc == null)
              throw new ArgumentNullException(nameof(doc));

          int len;
          doc.GetUrl(0, out len, null);
          if (len > 0)
          {
              var urlChars = new char[len];
              doc.GetUrl(len, out len, urlChars);
              Url = new string(urlChars, 0, len - 1);
          }

          doc.GetChecksum(0, out len, null);
          if (len > 0)
          {
              Checksum = new byte[len];
              doc.GetChecksum(len, out len, Checksum);
          }

          Guid id = Guid.Empty;
          doc.GetChecksumAlgorithmId(ref id);
          ChecksumAlgorithmId = id;
      }

      public string Url { get; private set; }
      public byte[] Checksum { get; private set; }
      public Guid ChecksumAlgorithmId { get; private set; }

      public byte[] ComputeChecksum()
      {
          HashAlgorithm algo;
          if (ChecksumAlgorithmId == CorSym_SourceHash_MD5)
          {
              algo = MD5.Create();
          }
          else if (ChecksumAlgorithmId == CorSym_SourceHash_SHA1)
          {
              algo = SHA1.Create();
          }
          else
              throw new NotSupportedException();

          try
          {
              return algo.ComputeHash(File.ReadAllBytes(Url));
          }
          finally
          {
              algo.Dispose();
          }
      }
  }

  [ComImport, Guid("0A29FF9E-7F9C-4437-8B11-F424491E3931")]
  internal class CorSymBinder_SxS // from corsym.h
  {
  }

  [ComImport, Guid("E5CB7A31-7512-11d2-89CE-0080C792E5D8")]
  internal class CorMetaDataDispenser // from cor.h
  {
  }

  [Guid("7DAC8207-D3AE-4c75-9B67-92801A497D44"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
  internal interface IMetaDataImport // from cor.h
  {
      // we don't need to use what's inside
  }

  [Guid("809c652e-7396-11d2-9771-00a0c9b4d50c"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
  internal interface IMetaDataDispenser // from cor.h
  {
      void _VtblGap0_1(); // skip 1 method
      IMetaDataImport OpenScope([MarshalAs(UnmanagedType.LPWStr)] string szScope, int dwOpenFlags, [MarshalAs(UnmanagedType.LPStruct)] Guid riid);
  }

答案 1 :(得分:3)

如果Guid匹配,您应该确定源匹配。我使用chkmatch命令行工具来比较年龄和Guid。 (见:http://www.debuginfo.com/tools/chkmatch.html

答案 2 :(得分:2)

您可以使用Microsoft CCIMono.Cecil从PDB中读取年龄和GUID,并从PE文件中的RSDS resource读取相同的信息。

如果年龄和GUID匹配,请考虑PDB和PE文件确实匹配。

可以使用symchk工具进一步验证匹配。