// Copyright (c) 2018 Siegfried Pammer // // Permission is hereby granted, free of charge, to any person obtaining a copy of this // software and associated documentation files (the "Software"), to deal in the Software // without restriction, including without limitation the rights to use, copy, modify, merge, // publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons // to whom the Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in all copies or // substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, // INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE // FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Reflection.Metadata; using System.Reflection.PortableExecutable; using System.Text; using System.Text.RegularExpressions; namespace ICSharpCode.Decompiler.Metadata { public enum TargetFrameworkIdentifier { NETFramework, NETCoreApp, NETStandard, Silverlight } enum DecompilerRuntime { NETFramework, NETCoreApp, Mono } // This is inspired by Mono.Cecil's BaseAssemblyResolver/DefaultAssemblyResolver. public class UniversalAssemblyResolver : IAssemblyResolver { static UniversalAssemblyResolver() { // TODO : test whether this works with Mono on *Windows*, not sure if we'll // ever need this... if (Type.GetType("Mono.Runtime") != null) decompilerRuntime = DecompilerRuntime.Mono; else if (typeof(object).Assembly.GetName().Name == "System.Private.CoreLib") decompilerRuntime = DecompilerRuntime.NETCoreApp; else if (Environment.OSVersion.Platform == PlatformID.Unix) decompilerRuntime = DecompilerRuntime.Mono; } DotNetCorePathFinder dotNetCorePathFinder; readonly bool throwOnError; readonly PEStreamOptions streamOptions; readonly MetadataReaderOptions metadataOptions; readonly string mainAssemblyFileName; readonly string baseDirectory; readonly List directories = new List(); static readonly List gac_paths = GetGacPaths(); HashSet targetFrameworkSearchPaths; static readonly DecompilerRuntime decompilerRuntime; public void AddSearchDirectory(string directory) { directories.Add(directory); dotNetCorePathFinder?.AddSearchDirectory(directory); } public void RemoveSearchDirectory(string directory) { directories.Remove(directory); dotNetCorePathFinder?.RemoveSearchDirectory(directory); } public string[] GetSearchDirectories() { return directories.ToArray(); } string targetFramework; TargetFrameworkIdentifier targetFrameworkIdentifier; Version targetFrameworkVersion; public UniversalAssemblyResolver(string mainAssemblyFileName, bool throwOnError, string targetFramework, PEStreamOptions streamOptions = PEStreamOptions.Default, MetadataReaderOptions metadataOptions = MetadataReaderOptions.Default) { this.streamOptions = streamOptions; this.metadataOptions = metadataOptions; this.targetFramework = targetFramework ?? string.Empty; (targetFrameworkIdentifier, targetFrameworkVersion) = ParseTargetFramework(this.targetFramework); this.mainAssemblyFileName = mainAssemblyFileName; this.baseDirectory = Path.GetDirectoryName(mainAssemblyFileName); this.throwOnError = throwOnError; if (string.IsNullOrWhiteSpace(this.baseDirectory)) this.baseDirectory = Environment.CurrentDirectory; AddSearchDirectory(baseDirectory); } internal static (TargetFrameworkIdentifier, Version) ParseTargetFramework(string targetFramework) { string[] tokens = targetFramework.Split(','); TargetFrameworkIdentifier identifier; switch (tokens[0].Trim().ToUpperInvariant()) { case ".NETCOREAPP": identifier = TargetFrameworkIdentifier.NETCoreApp; break; case ".NETSTANDARD": identifier = TargetFrameworkIdentifier.NETStandard; break; case "SILVERLIGHT": identifier = TargetFrameworkIdentifier.Silverlight; break; default: identifier = TargetFrameworkIdentifier.NETFramework; break; } Version version = null; for (int i = 1; i < tokens.Length; i++) { var pair = tokens[i].Trim().Split('='); if (pair.Length != 2) continue; switch (pair[0].Trim().ToUpperInvariant()) { case "VERSION": var versionString = pair[1].TrimStart('v', ' ', '\t'); if (identifier == TargetFrameworkIdentifier.NETCoreApp || identifier == TargetFrameworkIdentifier.NETStandard) { if (versionString.Length == 3) versionString += ".0"; } if (!Version.TryParse(versionString, out version)) version = null; break; } } return (identifier, version ?? ZeroVersion); } public PEFile Resolve(IAssemblyReference name) { var file = FindAssemblyFile(name); if (file == null) { if (throwOnError) throw new AssemblyResolutionException(name); return null; } return new PEFile(file, new FileStream(file, FileMode.Open, FileAccess.Read), streamOptions, metadataOptions); } public PEFile ResolveModule(PEFile mainModule, string moduleName) { string baseDirectory = Path.GetDirectoryName(mainModule.FileName); string moduleFileName = Path.Combine(baseDirectory, moduleName); if (!File.Exists(moduleFileName)) { if (throwOnError) throw new Exception($"Module {moduleName} could not be found!"); return null; } return new PEFile(moduleFileName, new FileStream(moduleFileName, FileMode.Open, FileAccess.Read), streamOptions, metadataOptions); } public virtual bool IsGacAssembly(IAssemblyReference reference) { return GetAssemblyInGac(reference) != null; } public string FindAssemblyFile(IAssemblyReference name) { if (name.IsWindowsRuntime) { return FindWindowsMetadataFile(name); } string file = null; switch (targetFrameworkIdentifier) { case TargetFrameworkIdentifier.NETCoreApp: case TargetFrameworkIdentifier.NETStandard: if (IsZeroOrAllOnes(targetFrameworkVersion)) goto default; if (dotNetCorePathFinder == null) { dotNetCorePathFinder = new DotNetCorePathFinder(mainAssemblyFileName, targetFramework, targetFrameworkIdentifier, targetFrameworkVersion); foreach (var directory in directories) { dotNetCorePathFinder.AddSearchDirectory(directory); } } file = dotNetCorePathFinder.TryResolveDotNetCore(name); if (file != null) return file; goto default; case TargetFrameworkIdentifier.Silverlight: if (IsZeroOrAllOnes(targetFrameworkVersion)) goto default; file = ResolveSilverlight(name, targetFrameworkVersion); if (file != null) return file; goto default; default: return ResolveInternal(name); } } string FindWindowsMetadataFile(IAssemblyReference name) { // Finding Windows Metadata (winmd) is currently only supported on Windows. if (Environment.OSVersion.Platform != PlatformID.Win32NT) return null; // TODO : Find a way to detect the base directory for the required Windows SDK. string basePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86), "Windows Kits", "10", "References"); if (!Directory.Exists(basePath)) return FindWindowsMetadataInSystemDirectory(name); // TODO : Find a way to detect the required Windows SDK version. var di = new DirectoryInfo(basePath); basePath = null; foreach (var versionFolder in di.EnumerateDirectories()) { basePath = versionFolder.FullName; } if (basePath == null) return FindWindowsMetadataInSystemDirectory(name); basePath = Path.Combine(basePath, name.Name); if (!Directory.Exists(basePath)) return FindWindowsMetadataInSystemDirectory(name); basePath = Path.Combine(basePath, FindClosestVersionDirectory(basePath, name.Version)); if (!Directory.Exists(basePath)) return FindWindowsMetadataInSystemDirectory(name); string file = Path.Combine(basePath, name.Name + ".winmd"); if (!File.Exists(file)) return FindWindowsMetadataInSystemDirectory(name); return file; } string FindWindowsMetadataInSystemDirectory(IAssemblyReference name) { string file = Path.Combine(Environment.SystemDirectory, "WinMetadata", name.Name + ".winmd"); if (File.Exists(file)) return file; return null; } void AddTargetFrameworkSearchPathIfExists(string path) { if (targetFrameworkSearchPaths == null) { targetFrameworkSearchPaths = new HashSet(); } if (Directory.Exists(path)) targetFrameworkSearchPaths.Add(path); } /// /// This only works on Windows /// string ResolveSilverlight(IAssemblyReference name, Version version) { AddTargetFrameworkSearchPathIfExists(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles), "Microsoft Silverlight")); AddTargetFrameworkSearchPathIfExists(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86), "Microsoft Silverlight")); foreach (var baseDirectory in targetFrameworkSearchPaths) { var versionDirectory = Path.Combine(baseDirectory, FindClosestVersionDirectory(baseDirectory, version)); var file = SearchDirectory(name, versionDirectory); if (file != null) return file; } return null; } string FindClosestVersionDirectory(string basePath, Version version) { string path = null; foreach (var folder in new DirectoryInfo(basePath).GetDirectories().Select(d => DotNetCorePathFinder.ConvertToVersion(d.Name)) .Where(v => v.Item1 != null).OrderByDescending(v => v.Item1)) { if (path == null || folder.Item1 >= version) path = folder.Item2; } return path ?? version.ToString(); } string ResolveInternal(IAssemblyReference name) { if (name == null) throw new ArgumentNullException(nameof(name)); var assembly = SearchDirectory(name, directories); if (assembly != null) return assembly; var framework_dir = Path.GetDirectoryName(typeof(object).Module.FullyQualifiedName); var framework_dirs = decompilerRuntime == DecompilerRuntime.Mono ? new[] { framework_dir, Path.Combine(framework_dir, "Facades") } : new[] { framework_dir }; if (IsSpecialVersionOrRetargetable(name)) { assembly = SearchDirectory(name, framework_dirs); if (assembly != null) return assembly; } if (name.Name == "mscorlib") { assembly = GetCorlib(name); if (assembly != null) return assembly; } assembly = GetAssemblyInGac(name); if (assembly != null) return assembly; assembly = SearchDirectory(name, framework_dirs); if (assembly != null) return assembly; if (throwOnError) throw new AssemblyResolutionException(name); return null; } #region .NET / mono GAC handling string SearchDirectory(IAssemblyReference name, IEnumerable directories) { foreach (var directory in directories) { string file = SearchDirectory(name, directory); if (file != null) return file; } return null; } static bool IsSpecialVersionOrRetargetable(IAssemblyReference reference) { return IsZeroOrAllOnes(reference.Version) || reference.IsRetargetable; } string SearchDirectory(IAssemblyReference name, string directory) { var extensions = name.IsWindowsRuntime ? new[] { ".winmd", ".dll" } : new[] { ".exe", ".dll" }; foreach (var extension in extensions) { string file = Path.Combine(directory, name.Name + extension); if (!File.Exists(file)) continue; try { return file; } catch (BadImageFormatException) { continue; } } return null; } static bool IsZeroOrAllOnes(Version version) { return version == null || (version.Major == 0 && version.Minor == 0 && version.Build == 0 && version.Revision == 0) || (version.Major == 65535 && version.Minor == 65535 && version.Build == 65535 && version.Revision == 65535); } internal static Version ZeroVersion = new Version(0,0,0,0); string GetCorlib(IAssemblyReference reference) { var version = reference.Version; var corlib = typeof(object).Assembly.GetName(); if (decompilerRuntime != DecompilerRuntime.NETCoreApp) { if (corlib.Version == version || IsSpecialVersionOrRetargetable(reference)) return typeof(object).Module.FullyQualifiedName; } string path; if (decompilerRuntime == DecompilerRuntime.Mono) { path = GetMonoMscorlibBasePath(version); } else { path = GetMscorlibBasePath(version, reference.PublicKeyToken.ToHexString(8)); } if (path == null) return null; var file = Path.Combine(path, "mscorlib.dll"); if (File.Exists(file)) return file; return null; } string GetMscorlibBasePath(Version version, string publicKeyToken) { string GetSubFolderForVersion() { switch (version.Major) { case 1: if (version.MajorRevision == 3300) return "v1.0.3705"; return "v1.1.4322"; case 2: return "v2.0.50727"; case 4: return "v4.0.30319"; default: if (throwOnError) throw new NotSupportedException("Version not supported: " + version); return null; } } if (publicKeyToken == "969db8053d3322ac") { string programFiles = Environment.Is64BitOperatingSystem ? Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86) : Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles); string cfPath = $@"Microsoft.NET\SDK\CompactFramework\v{version.Major}.{version.Minor}\WindowsCE\"; string cfBasePath = Path.Combine(programFiles, cfPath); if (Directory.Exists(cfBasePath)) return cfBasePath; } else { string rootPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.Windows), "Microsoft.NET"); string[] frameworkPaths = new[] { Path.Combine(rootPath, "Framework"), Path.Combine(rootPath, "Framework64") }; string folder = GetSubFolderForVersion(); if (folder != null) { foreach (var path in frameworkPaths) { var basePath = Path.Combine(path, folder); if (Directory.Exists(basePath)) return basePath; } } } if (throwOnError) throw new NotSupportedException("Version not supported: " + version); return null; } string GetMonoMscorlibBasePath(Version version) { var path = Directory.GetParent(typeof(object).Module.FullyQualifiedName).Parent.FullName; if (version.Major == 1) path = Path.Combine(path, "1.0"); else if (version.Major == 2) { if (version.MajorRevision == 5) path = Path.Combine(path, "2.1"); else path = Path.Combine(path, "2.0"); } else if (version.Major == 4) path = Path.Combine(path, "4.0"); else { if (throwOnError) throw new NotSupportedException("Version not supported: " + version); return null; } return path; } public static List GetGacPaths() { if (decompilerRuntime == DecompilerRuntime.Mono) return GetDefaultMonoGacPaths(); var paths = new List(2); var windir = Environment.GetFolderPath(Environment.SpecialFolder.Windows); if (windir == null) return paths; paths.Add(Path.Combine(windir, "assembly")); paths.Add(Path.Combine(windir, "Microsoft.NET", "assembly")); return paths; } static List GetDefaultMonoGacPaths() { var paths = new List(1); var gac = GetCurrentMonoGac(); if (gac != null) paths.Add(gac); var gac_paths_env = Environment.GetEnvironmentVariable("MONO_GAC_PREFIX"); if (string.IsNullOrEmpty(gac_paths_env)) return paths; var prefixes = gac_paths_env.Split(Path.PathSeparator); foreach (var prefix in prefixes) { if (string.IsNullOrEmpty(prefix)) continue; var gac_path = Path.Combine(Path.Combine(Path.Combine(prefix, "lib"), "mono"), "gac"); if (Directory.Exists(gac_path) && !paths.Contains(gac)) paths.Add(gac_path); } return paths; } static string GetCurrentMonoGac() { return Path.Combine( Directory.GetParent( Path.GetDirectoryName(typeof(object).Module.FullyQualifiedName)).FullName, "gac"); } public static string GetAssemblyInGac(IAssemblyReference reference) { if (reference.PublicKeyToken == null || reference.PublicKeyToken.Length == 0) return null; if (decompilerRuntime == DecompilerRuntime.Mono) return GetAssemblyInMonoGac(reference); return GetAssemblyInNetGac(reference); } static string GetAssemblyInMonoGac(IAssemblyReference reference) { for (int i = 0; i < gac_paths.Count; i++) { var gac_path = gac_paths[i]; var file = GetAssemblyFile(reference, string.Empty, gac_path); if (File.Exists(file)) return file; } return null; } static string GetAssemblyInNetGac(IAssemblyReference reference) { var gacs = new[] { "GAC_MSIL", "GAC_32", "GAC_64", "GAC" }; var prefixes = new[] { string.Empty, "v4.0_" }; for (int i = 0; i < gac_paths.Count; i++) { for (int j = 0; j < gacs.Length; j++) { var gac = Path.Combine(gac_paths[i], gacs[j]); var file = GetAssemblyFile(reference, prefixes[i], gac); if (Directory.Exists(gac) && File.Exists(file)) return file; } } return null; } static string GetAssemblyFile(IAssemblyReference reference, string prefix, string gac) { var gac_folder = new StringBuilder() .Append(prefix) .Append(reference.Version) .Append("__"); for (int i = 0; i < reference.PublicKeyToken.Length; i++) gac_folder.Append(reference.PublicKeyToken[i].ToString("x2")); return Path.Combine( Path.Combine( Path.Combine(gac, reference.Name), gac_folder.ToString()), reference.Name + ".dll"); } /// /// Gets the names of all assemblies in the GAC. /// public static IEnumerable EnumerateGac() { var gacs = new[] { "GAC_MSIL", "GAC_32", "GAC_64", "GAC" }; foreach (var path in GetGacPaths()) { foreach (var gac in gacs) { string rootPath = Path.Combine(path, gac); if (!Directory.Exists(rootPath)) continue; foreach (var item in new DirectoryInfo(rootPath).EnumerateFiles("*.dll", SearchOption.AllDirectories)) { string[] name = Path.GetDirectoryName(item.FullName).Substring(rootPath.Length + 1).Split(new[] { "\\" }, StringSplitOptions.RemoveEmptyEntries); if (name.Length != 2) continue; var match = Regex.Match(name[1], $"(v4.0_)?(?[^_]+)_(?[^_]+)?_(?[^_]+)"); if (!match.Success) continue; string culture = match.Groups["culture"].Value; if (string.IsNullOrEmpty(culture)) culture = "neutral"; yield return AssemblyNameReference.Parse(name[0] + ", Version=" + match.Groups["version"].Value + ", Culture=" + culture + ", PublicKeyToken=" + match.Groups["publicKey"].Value); } } } } #endregion } }