C# - 코드를 통해 PDB 심벌 파일 다운로드 방법
물론 symchk.exe를 이용하면 쉽게 다운로드할 수 있지만,
pdb 파일을 다운로드하기 위한 symchk.exe 실행에 필요한 최소 파일
; https://www.sysnet.pe.kr/2/0/12091
관련 DLL들은 재배포 가능할 수 있어도 exe 파일에 대한 언급이 없습니다.
DbgHelp Versions
; https://learn.microsoft.com/en-us/windows/win32/debug/dbghelp-versions
The most current versions of DbgHelp.dll, SymSrv.dll, and SrcSrv.dll are available as a part of the Debugging Tools For Windows package. The redistribution policies for these included DLLs were specifically designed to make it as easy as possible for people to include these files in their own packages and releases.
The DbgHelp.dll file that ships in Windows is not redistributable.
그래서 ^^ 그냥 직접 다운로드하는 코드를 만들어 봤습니다.
기반 지식은 이미 다 정리가 되었습니다. 아래의 글에서 PDB 파일의 경로 구성을 알아봤고,
PDB 기호 파일의 경로 구성 방식
; https://www.sysnet.pe.kr/2/0/2925
위의 지식을 기반으로 PE 파일로부터 정보를 얻는 방법도 설명했습니다.
C# - PDB 파일 경로를 PE 파일로부터 얻는 방법
; https://www.sysnet.pe.kr/2/0/11237
또한, 마이크로소프트의 심벌 서버에서 다운로드하는 방법도 알았으니,
PDB 파일을 수동으로 다운로드하는 방법
; https://www.sysnet.pe.kr/2/0/11096
이제 이것들을 잘 조합하기만 하면 됩니다. 우선, PE 파일의 헤더로부터 Debug Directory를 가져오는 코드를 지난 글에 소개한 예제를 확장해 구현했습니다.
C# - 로딩된 Native DLL의 export 함수 목록 출력
; https://www.sysnet.pe.kr/2/0/12093
남은 작업은, 이렇게 구성한 PDB 파일 경로를 이용해 msdl.microsoft.com 심벌 서버로부터 다운로드하는 것인데 이에 대해서는 다음의 글에 소개한,
PDB Downloader
; https://blogs.msdn.microsoft.com/webtopics/2016/03/07/pdb-downloader/
PDB Downloader에서 힌트를 얻었습니다. 물론, 소스 코드를 직접 분석하기보다는 그냥 fiddler를 이용해 네트워크 패킷을 보는 것이 더 직관적일 수 있는데요, 우선, "HEAD" method 쿼리를 이용해,
HEAD http://msdl.microsoft.com/download/symbols/ntdll.pdb/0C2E19EA1901E9B82E4567D2D21E56D21/ntdll.pdb HTTP/1.1
User-Agent: Microsoft-Symbol-Server/10.0.10522.521
Host: msdl.microsoft.com
Connection: Keep-Alive
요청을 보내면 다음과 같이 "Location" 헤더에 실제 다운로드할 수 있는 URL이 담겨 옵니다.
HTTP/1.1 302 Found
Cache-Control: no-store, no-cache, max-age=0
Content-Length: 0
Location: https://vsblobprodscussu5shard62.blob.core.windows.net/b-4712e0edc5a240eabf23330d7df68e77/73D63042197DD1EE7B80F...[생략]...4cb6588
X-Cache: TCP_MISS
Server: Microsoft-HTTPAPI/2.0
X-MSEdge-Ref: Ref A: 6A044B29569A4FB582D54408AC47B3E5 Ref B: SLAEDGE0919 Ref C: 2019-12-25T03:49:24Z
Date: Wed, 25 Dec 2019 03:49:23 GMT
그렇군요, 그러니까 PDB 파일 다운로드는 HEAD + GET의 조합으로 가능하다는 것입니다. (2020-11-23 업데이트: 현재 HEAD 요청 없이 곧바로 다운로드가 가능합니다.) 아래의 소스 코드는 PEImage.cs의 코드를 이용해 PDB 파일을 다운로드하는 예제입니다.
// ...[생략]...
class Program
{
static void Main(string[] args)
{
// DownloadPdbs(false);
DownloadPdbs(true);
}
private static void DownloadPdbs(bool fromFile)
{
string rootPathToSave = Path.Combine(Environment.CurrentDirectory, "sym");
if (Directory.Exists(rootPathToSave) == false)
{
Directory.CreateDirectory(rootPathToSave);
}
Process currentProcess = Process.GetCurrentProcess();
foreach (ProcessModule pm in currentProcess.Modules)
{
Console.WriteLine($"[{pm.FileName}, 0x{pm.BaseAddress.ToString("x")}]");
PEImage pe = null;
if (fromFile == true)
{
pe = PEImage.ReadFromFile(pm.FileName);
}
else
{
pe = PEImage.ReadFromMemory(pm.BaseAddress, pm.ModuleMemorySize);
}
if (pe == null)
{
Console.WriteLine("Failed to read images");
return;
}
string modulePath = pm.FileName;
DownloadPdb(modulePath, rootPathToSave);
Console.WriteLine();
}
}
private static void DownloadPdb(string modulePath, string rootPathToSave)
{
if (File.Exists(modulePath) == false)
{
Console.WriteLine("NOT Found: " + modulePath);
return;
}
PEImage pe = PEImage.ReadFromFile(modulePath);
if (pe == null)
{
Console.WriteLine("Failed to read images");
return;
}
Uri baseUri = new Uri("https://msdl.microsoft.com/download/symbols/");
foreach (CodeViewRSDS codeView in pe.EnumerateCodeViewDebugInfo())
{
if (string.IsNullOrEmpty(codeView.PdbFileName) == true)
{
continue;
}
string pdbFileName = codeView.PdbFileName;
if (Path.IsPathRooted(codeView.PdbFileName) == true)
{
pdbFileName = Path.GetFileName(codeView.PdbFileName);
}
Console.WriteLine("\tFileName: " + pdbFileName);
Console.WriteLine("\tPdbFileName: " + codeView.PdbFileName);
Console.WriteLine("\tLocal: " + codeView.PdbLocalPath);
Console.WriteLine("\tUri: " + codeView.PdbUriPath);
string localPath = Path.Combine(rootPathToSave, codeView.PdbLocalPath);
string localFolder = Path.GetDirectoryName(localPath);
if (Directory.Exists(localFolder) == false)
{
try
{
Directory.CreateDirectory(localFolder);
}
catch (DirectoryNotFoundException)
{
Console.WriteLine("NOT Found on local: " + codeView.PdbLocalPath);
continue;
}
}
if (File.Exists(localPath) == true)
{
Console.WriteLine("Found on local: " + pdbFileName);
continue;
}
if (CopyPdbFromLocal(modulePath, codeView.PdbFileName, localPath) == true)
{
Console.WriteLine("Found on local: " + pdbFileName);
continue;
}
Uri target = new Uri(baseUri, codeView.PdbUriPath);
Console.WriteLine(target);
Uri pdbLocation = GetPdbLocation(target);
if (pdbLocation == null)
{
string underscorePath = ProbeWithUnderscore(target.AbsoluteUri);
pdbLocation = GetPdbLocation(new Uri(underscorePath));
}
if (pdbLocation != null)
{
DownloadPdbFile(pdbLocation, localPath);
}
else
{
Console.WriteLine("Not Found on symbol server: " + codeView.PdbFileName);
}
}
Console.WriteLine();
}
private static bool CopyPdbFromLocal(string modulePath, string pdbFileName, string localTargetPath)
{
if (File.Exists(pdbFileName) == true)
{
File.Copy(pdbFileName, localTargetPath);
return File.Exists(localTargetPath);
}
string fileName = Path.GetFileName(pdbFileName);
string pdbPath = Path.Combine(Environment.CurrentDirectory, fileName);
if (File.Exists(pdbPath) == true)
{
File.Copy(pdbPath, localTargetPath);
return File.Exists(localTargetPath);
}
pdbPath = Path.ChangeExtension(modulePath, ".pdb");
if (File.Exists(pdbPath) == true)
{
File.Copy(pdbPath, localTargetPath);
return File.Exists(localTargetPath);
}
return false;
}
private static string ProbeWithUnderscore(string path)
{
path = path.Remove(path.Length - 1);
path = path.Insert(path.Length, "_");
return path;
}
private static void DownloadPdbFile(Uri target, string pathToSave)
{
System.Net.HttpWebRequest req = System.Net.WebRequest.Create(target) as System.Net.HttpWebRequest;
using (System.Net.HttpWebResponse resp = req.GetResponse() as System.Net.HttpWebResponse)
using (FileStream fs = new FileStream(pathToSave, FileMode.CreateNew, FileAccess.Write, FileShare.None))
using (BinaryWriter bw = new BinaryWriter(fs))
{
BinaryReader reader = new BinaryReader(resp.GetResponseStream());
long contentLength = resp.ContentLength;
while (contentLength > 0)
{
byte[] buffer = new byte[4096];
int readBytes = reader.Read(buffer, 0, buffer.Length);
bw.Write(buffer, 0, readBytes);
contentLength -= readBytes;
}
}
}
private static Uri GetPdbLocation(Uri target)
{
System.Net.HttpWebRequest req = System.Net.WebRequest.Create(target) as System.Net.HttpWebRequest;
req.Method = "HEAD";
try
{
using (System.Net.HttpWebResponse resp = req.GetResponse() as System.Net.HttpWebResponse)
{
return resp.ResponseUri;
}
}
catch (System.Net.WebException)
{
return null;
}
}
}
완전하게 동작하는 코드는 다음의 github에 공개되어 있습니다.
DotNetSamples/WinConsole/PEFormat/PEFormatSample/
; https://github.com/stjeong/DotNetSamples/tree/master/WinConsole/PEFormat/PEFormatSample
DotNetSamples/WinConsole/PEFormat/WindowsPE/
; https://github.com/stjeong/DotNetSamples/tree/master/WinConsole/PEFormat/WindowsPE
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]