|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using Microsoft.Build.Utilities;
using Microsoft.Win32;
using System;
#if !RUNTIME_TYPE_NETCORE
using Microsoft.Build.Framework;
using System.Collections.Generic;
#endif
using System.ComponentModel;
using System.Deployment.Internal.CodeSigning;
using System.Diagnostics;
#if !RUNTIME_TYPE_NETCORE
using System.Diagnostics.CodeAnalysis;
#endif
using System.Globalization;
using System.IO;
#if !RUNTIME_TYPE_NETCORE
using System.Reflection;
#endif
using System.Runtime.InteropServices;
using System.Runtime.Versioning;
using System.Security;
using System.Security.Cryptography;
using System.Security.Cryptography.X509Certificates;
#if !RUNTIME_TYPE_NETCORE
using System.Security.Permissions;
using System.Security.Policy;
#endif
using System.Text;
using System.Xml;
using Microsoft.Build.Shared.FileSystem;
#nullable disable
namespace Microsoft.Build.Tasks.Deployment.ManifestUtilities
{
/// <summary>
/// Provides a set of utility functions for manipulating security permision sets and signing.
/// </summary>
[ComVisible(false)]
public static class SecurityUtilities
{
#if RUNTIME_TYPE_NETCORE
// Partial trust and permission sets are not supported by .NET Core.
#else
private const string PermissionSetsFolder = "PermissionSets";
private const string LocalIntranet = "LocalIntranet";
private const string Internet = "Internet";
private const string Custom = "Custom";
#endif
private const string ToolName = "signtool.exe";
#if !RUNTIME_TYPE_NETCORE
private const int Fx2MajorVersion = 2;
private const int Fx3MajorVersion = 3;
private static readonly Version s_dotNet40Version = new Version("4.0");
#endif
private static readonly Version s_dotNet45Version = new Version("4.5");
#if !RUNTIME_TYPE_NETCORE
private const string InternetPermissionSetXml = "<PermissionSet class=\"System.Security.PermissionSet\" version=\"1\" ID=\"Custom\" SameSite=\"site\">\n" +
"<IPermission class=\"System.Security.Permissions.FileDialogPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Access=\"Open\" />\n" +
"<IPermission class=\"System.Security.Permissions.IsolatedStorageFilePermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Allowed=\"ApplicationIsolationByUser\" UserQuota=\"512000\" />\n" +
"<IPermission class=\"System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Flags=\"Execution\" />\n" +
"<IPermission class=\"System.Security.Permissions.UIPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Window=\"SafeTopLevelWindows\" Clipboard=\"OwnClipboard\" />\n" +
"<IPermission class=\"System.Drawing.Printing.PrintingPermission, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a\" version=\"1\" Level=\"SafePrinting\" />\n" +
"</PermissionSet>";
private const string LocalIntranetPermissionSetXml = "<PermissionSet class=\"System.Security.PermissionSet\" version=\"1\" ID=\"Custom\" SameSite=\"site\">\n" +
"<IPermission class=\"System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Read=\"USERNAME\" />\n" +
"<IPermission class=\"System.Security.Permissions.FileDialogPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Unrestricted=\"true\" />\n" +
"<IPermission class=\"System.Security.Permissions.IsolatedStorageFilePermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Allowed=\"AssemblyIsolationByUser\" UserQuota=\"9223372036854775807\" Expiry=\"9223372036854775807\" Permanent=\"True\" />\n" +
"<IPermission class=\"System.Security.Permissions.ReflectionPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Flags=\"ReflectionEmit\" />\n" +
"<IPermission class=\"System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Flags=\"Assertion, Execution, BindingRedirects\" />\n" +
"<IPermission class=\"System.Security.Permissions.UIPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Unrestricted=\"true\" />\n" +
"<IPermission class=\"System.Net.DnsPermission, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Unrestricted=\"true\" />\n" +
"<IPermission class=\"System.Drawing.Printing.PrintingPermission, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a\" version=\"1\" Level=\"DefaultPrinting\" />\n" +
"</PermissionSet>";
private const string InternetPermissionSetWithWPFXml = "<PermissionSet class=\"System.Security.PermissionSet\" version=\"1\" ID=\"Custom\" SameSite=\"site\">\n" +
"<IPermission class=\"System.Security.Permissions.FileDialogPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Access=\"Open\" />\n" +
"<IPermission class=\"System.Security.Permissions.IsolatedStorageFilePermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Allowed=\"ApplicationIsolationByUser\" UserQuota=\"512000\" />\n" +
"<IPermission class=\"System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Flags=\"Execution\" />\n" +
"<IPermission class=\"System.Security.Permissions.UIPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Window=\"SafeTopLevelWindows\" Clipboard=\"OwnClipboard\" />\n" +
"<IPermission class=\"System.Drawing.Printing.PrintingPermission, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a\" version=\"1\" Level=\"SafePrinting\" />\n" +
"<IPermission class=\"System.Security.Permissions.MediaPermission, WindowsBase, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35\" version=\"1\" Audio=\"SafeAudio\" Video=\"SafeVideo\" Image=\"SafeImage\" />\n" +
"<IPermission class=\"System.Security.Permissions.WebBrowserPermission, WindowsBase, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35\" version=\"1\" Level=\"Safe\" />\n" +
"</PermissionSet>";
private const string LocalIntranetPermissionSetWithWPFXml = "<PermissionSet class=\"System.Security.PermissionSet\" version=\"1\" ID=\"Custom\" SameSite=\"site\">\n" +
"<IPermission class=\"System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Read=\"USERNAME\" />\n" +
"<IPermission class=\"System.Security.Permissions.FileDialogPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Unrestricted=\"true\" />\n" +
"<IPermission class=\"System.Security.Permissions.IsolatedStorageFilePermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Allowed=\"AssemblyIsolationByUser\" UserQuota=\"9223372036854775807\" Expiry=\"9223372036854775807\" Permanent=\"True\" />\n" +
"<IPermission class=\"System.Security.Permissions.ReflectionPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Flags=\"ReflectionEmit\" />\n" +
"<IPermission class=\"System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Flags=\"Assertion, Execution, BindingRedirects\" />\n" +
"<IPermission class=\"System.Security.Permissions.UIPermission, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Unrestricted=\"true\" />\n" +
"<IPermission class=\"System.Net.DnsPermission, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\" version=\"1\" Unrestricted=\"true\" />\n" +
"<IPermission class=\"System.Drawing.Printing.PrintingPermission, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a\" version=\"1\" Level=\"DefaultPrinting\" />\n" +
"<IPermission class=\"System.Security.Permissions.MediaPermission, WindowsBase, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35\" version=\"1\" Audio=\"SafeAudio\" Video=\"SafeVideo\" Image=\"SafeImage\" />\n" +
"<IPermission class=\"System.Security.Permissions.WebBrowserPermission, WindowsBase, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35\" version=\"1\" Level=\"Safe\" />\n" +
"</PermissionSet>";
/// <summary>
/// Generates a permission set by computed the zone default permission set and adding any included permissions.
/// </summary>
/// <param name="targetZone">Specifies a zone default permission set, which is obtained from machine policy. Valid values are "Internet", "LocalIntranet", or "Custom". If "Custom" is specified, the generated permission set is based only on the includedPermissionSet parameter.</param>
/// <param name="includedPermissionSet">A PermissionSet object containing the set of permissions to be explicitly included in the generated permission set. Permissions specified in this parameter will be included verbatim in the generated permission set, regardless of targetZone parameter.</param>
/// <param name="excludedPermissions">This property is no longer used.</param>
/// <returns>The generated permission set.</returns>
public static PermissionSet ComputeZonePermissionSet(string targetZone, PermissionSet includedPermissionSet, string[] excludedPermissions)
{
return ComputeZonePermissionSetHelper(targetZone, includedPermissionSet, null, string.Empty);
}
internal static PermissionSet ComputeZonePermissionSetHelper(string targetZone, PermissionSet includedPermissionSet, ITaskItem[] dependencies, string targetFrameworkMoniker)
{
// Custom Set.
if (String.IsNullOrEmpty(targetZone) || String.Equals(targetZone, Custom, StringComparison.OrdinalIgnoreCase))
{
// just return the included set, no magic
return includedPermissionSet.Copy();
}
PermissionSet retSet = GetNamedPermissionSetFromZone(targetZone, targetFrameworkMoniker);
return retSet;
}
private static PermissionSet GetNamedPermissionSetFromZone(string targetZone, string targetFrameworkMoniker)
{
return targetZone switch
{
LocalIntranet => GetNamedPermissionSet(LocalIntranet, targetFrameworkMoniker),
Internet => GetNamedPermissionSet(Internet, targetFrameworkMoniker),
_ => throw new ArgumentException(String.Empty /* no message */, nameof(targetZone)),
};
}
private static PermissionSet GetNamedPermissionSet(string targetZone, string targetFrameworkMoniker)
{
FrameworkName fn;
if (!string.IsNullOrEmpty(targetFrameworkMoniker))
{
fn = new FrameworkName(targetFrameworkMoniker);
}
else
{
fn = new FrameworkName(".NETFramework", s_dotNet40Version);
}
int majorVersion = fn.Version.Major;
if (majorVersion == Fx2MajorVersion)
{
return XmlToPermissionSet(GetXmlElement(targetZone, majorVersion));
}
else if (majorVersion == Fx3MajorVersion)
{
return XmlToPermissionSet(GetXmlElement(targetZone, majorVersion));
}
else
{
return XmlToPermissionSet(GetXmlElement(targetZone, fn));
}
}
private static XmlElement GetXmlElement(string targetZone, FrameworkName fn)
{
IList<string> paths = ToolLocationHelper.GetPathToReferenceAssemblies(fn);
// Is the targeted CLR even installed?
if (paths.Count > 0)
{
// first one is always framework requested.
string path = Path.Combine(paths[0], PermissionSetsFolder);
// PermissionSets folder doesn't exit
if (FileSystems.Default.DirectoryExists(path))
{
string[] files = Directory.GetFiles(path, "*.xml");
var filesInfo = new FileInfo[files.Length];
int indexFound = -1;
// trim the extension.
for (int i = 0; i < files.Length; i++)
{
filesInfo[i] = new FileInfo(files[i]);
string fileInfoNoExt = Path.GetFileNameWithoutExtension(files[i]);
if (string.Equals(fileInfoNoExt, targetZone, StringComparison.OrdinalIgnoreCase))
{
indexFound = i;
break;
}
}
if (indexFound != -1)
{
FileInfo resultFile = filesInfo[indexFound];
using (FileStream fs = resultFile.OpenRead())
{
try
{
using var sr = new StreamReader(fs, Encoding.UTF8, detectEncodingFromByteOrderMarks: true, 1024, leaveOpen: true);
string data = sr.ReadToEnd();
if (!string.IsNullOrEmpty(data))
{
var doc = new XmlDocument();
var xrSettings =
new XmlReaderSettings
{
DtdProcessing = DtdProcessing.Ignore,
ConformanceLevel = ConformanceLevel.Auto
};
// http://msdn.microsoft.com/en-us/library/h2344bs2(v=vs.110).aspx
// PermissionSets do not conform to document level, which is the default setting.
try
{
fs.Position = 0; // Reset to 0 before using this stream in any other reader.
using (XmlReader xr = XmlReader.Create(fs, xrSettings))
{
doc.Load(xr);
return doc.DocumentElement;
}
}
catch (Exception)
{
// continue.
}
}
}
catch (ArgumentException)
{
// continue.
}
}
}
}
}
return GetCurrentCLRPermissions(targetZone);
}
[SuppressMessage("Microsoft.Security.Xml", "CA3057: DoNotUseLoadXml.")]
private static XmlElement GetCurrentCLRPermissions(string targetZone)
{
var zone = targetZone switch
{
LocalIntranet => SecurityZone.Intranet,
Internet => SecurityZone.Internet,
_ => throw new ArgumentException(String.Empty /* no message */, nameof(targetZone)),
};
var evidence = new Evidence(new EvidenceBase[] { new Zone(zone), new System.Runtime.Hosting.ActivationArguments(new System.ApplicationIdentity("")) }, null);
PermissionSet sandbox = SecurityManager.GetStandardSandbox(evidence);
string resultInString = sandbox.ToString();
if (!string.IsNullOrEmpty(resultInString))
{
var doc = new XmlDocument();
// CA3057: DoNotUseLoadXml. Suppressed since the xml being loaded is a string representation of the PermissionSet.
doc.LoadXml(resultInString);
return doc.DocumentElement;
}
return null;
}
private static XmlElement GetXmlElement(string targetZone, int majorVersion)
{
XmlDocument doc = majorVersion switch
{
Fx2MajorVersion => CreateXmlDocV2(targetZone),
Fx3MajorVersion => CreateXmlDocV3(targetZone),
_ => throw new ArgumentException(String.Empty /* no message */, nameof(majorVersion)),
};
XmlElement rootElement = doc.DocumentElement;
return rootElement;
}
[SuppressMessage("Microsoft.Security.Xml", "CA3057: DoNotUseLoadXml.")]
private static XmlDocument CreateXmlDocV2(string targetZone)
{
var doc = new XmlDocument();
switch (targetZone)
{
case LocalIntranet:
// CA3057: DoNotUseLoadXml. Suppressed since is LocalIntranetPermissionSetXml a constant string.
doc.LoadXml(LocalIntranetPermissionSetXml);
return doc;
case Internet:
// CA3057: DoNotUseLoadXml. Suppressed since is InternetPermissionSetXml a constant string.
doc.LoadXml(InternetPermissionSetXml);
return doc;
default:
throw new ArgumentException(String.Empty /* no message */, nameof(targetZone));
}
}
[SuppressMessage("Microsoft.Security.Xml", "CA3057: DoNotUseLoadXml.")]
private static XmlDocument CreateXmlDocV3(string targetZone)
{
var doc = new XmlDocument();
switch (targetZone)
{
case LocalIntranet:
// CA3057: DoNotUseLoadXml. Suppressed since is LocalIntranetPermissionSetXml a constant string.
doc.LoadXml(LocalIntranetPermissionSetWithWPFXml);
return doc;
case Internet:
// CA3057: DoNotUseLoadXml. Suppressed since is InternetPermissionSetXml a constant string.
doc.LoadXml(InternetPermissionSetWithWPFXml);
return doc;
default:
throw new ArgumentException(String.Empty /* no message */, nameof(targetZone));
}
}
internal static bool ParseElementForAssemblyIdentification(SecurityElement el,
out String className,
out String assemblyName, // for example "WindowsBase"
out String assemblyVersion)
{
className = null;
assemblyName = null;
assemblyVersion = null;
String fullClassName = el.Attribute("class");
if (fullClassName == null)
{
return false;
}
if (fullClassName.IndexOf('\'') >= 0)
{
fullClassName = fullClassName.Replace('\'', '\"');
}
int commaIndex = fullClassName.IndexOf(',');
// If the classname is tagged with assembly information, find where
// the assembly information begins.
if (commaIndex == -1)
{
return false;
}
int namespaceClassNameLength = commaIndex;
className = fullClassName.Substring(0, namespaceClassNameLength);
String assemblyFullName = fullClassName.Substring(commaIndex + 1);
var an = new AssemblyName(assemblyFullName);
assemblyName = an.Name;
assemblyVersion = an.Version.ToString();
return true;
}
/// <summary>
/// Converts an array of permission identity strings to a permission set object.
/// </summary>
/// <param name="ids">An array of permission identity strings.</param>
/// <returns>The converted permission set.</returns>
public static PermissionSet IdentityListToPermissionSet(string[] ids)
{
var document = new XmlDocument();
XmlElement permissionSetElement = document.CreateElement("PermissionSet");
document.AppendChild(permissionSetElement);
foreach (string id in ids)
{
XmlElement permissionElement = document.CreateElement("IPermission");
XmlAttribute a = document.CreateAttribute("class");
a.Value = id;
permissionElement.Attributes.Append(a);
permissionSetElement.AppendChild(permissionElement);
}
return XmlToPermissionSet(permissionSetElement);
}
/// <summary>
/// Converts a permission set object to an array of permission identity strings.
/// </summary>
/// <param name="permissionSet">The input permission set to be converted.</param>
/// <returns>An array of permission identity strings.</returns>
[SuppressMessage("Microsoft.Security.Xml", "CA3057: DoNotUseLoadXml.")]
public static string[] PermissionSetToIdentityList(PermissionSet permissionSet)
{
string psXml = permissionSet?.ToString() ?? "<PermissionSet/>";
var psDocument = new XmlDocument();
// CA3057: DoNotUseLoadXml. Suppressed since 'psXml' is a trusted or a constant string.
psDocument.LoadXml(psXml);
return XmlToIdentityList(psDocument.DocumentElement);
}
[SuppressMessage("Microsoft.Security.Xml", "CA3057: DoNotUseLoadXml.")]
internal static XmlDocument PermissionSetToXml(PermissionSet ps)
{
XmlDocument inputDocument = new XmlDocument();
string xml = ps?.ToString() ?? "<PermissionSet/>";
// CA3057: DoNotUseLoadXml. Suppressed since 'xml' is a trusted or a constant string.
inputDocument.LoadXml(xml);
var outputDocument = new XmlDocument();
XmlElement psElement = XmlUtil.CloneElementToDocument(inputDocument.DocumentElement, outputDocument, XmlNamespaces.asmv2);
outputDocument.AppendChild(psElement);
return outputDocument;
}
private static SecurityElement XmlElementToSecurityElement(XmlElement xe)
{
SecurityElement se = new SecurityElement(xe.Name);
foreach (XmlAttribute xa in xe.Attributes)
{
se.AddAttribute(xa.Name, xa.Value);
}
foreach (XmlNode xn in xe.ChildNodes)
{
if (xn.NodeType == XmlNodeType.Element)
{
se.AddChild(XmlElementToSecurityElement((XmlElement)xn));
}
}
return se;
}
private static string[] XmlToIdentityList(XmlElement psElement)
{
XmlNamespaceManager nsmgr = XmlNamespaces.GetNamespaceManager(psElement.OwnerDocument.NameTable);
XmlNodeList nodes = psElement.SelectNodes(XPaths.permissionClassAttributeQuery, nsmgr);
if (nodes == null || nodes.Count == 0)
{
nodes = psElement.SelectNodes(XmlUtil.TrimPrefix(XPaths.permissionClassAttributeQuery));
}
string[] a;
if (nodes != null)
{
a = new string[nodes.Count];
int i = 0;
foreach (XmlNode node in nodes)
{
a[i++] = node.Value;
}
}
else
{
a = Array.Empty<string>();
}
return a;
}
/// <summary>
/// Converts an XmlElement into a PermissionSet object.
/// </summary>
/// <param name="element">An XML representation of the permission set.</param>
/// <returns>The converted permission set.</returns>
public static PermissionSet XmlToPermissionSet(XmlElement element)
{
if (element == null)
{
return null;
}
SecurityElement se = XmlElementToSecurityElement(element);
if (se == null)
{
return null;
}
PermissionSet ps = new PermissionSet(PermissionState.None);
try
{
ps = new ReadOnlyPermissionSet(se);
}
catch (ArgumentException ex)
{
// UNDONE: Need to log exception thrown from PermissionSet.FromXml
Debug.Fail(String.Format(CultureInfo.CurrentCulture, "PermissionSet.FromXml failed: {0}\r\n\r\n{1}", ex.Message, element.OuterXml));
return null;
}
return ps;
}
#endif
/// <summary>
/// Signs a ClickOnce manifest or PE file.
/// </summary>
/// <param name="certThumbprint">Hexadecimal string that contains the SHA-1 hash of the certificate.</param>
/// <param name="timestampUrl">URL that specifies an address of a time stamping server.</param>
/// <param name="path">Path of the file to sign with the certificate.</param>
[SupportedOSPlatform("windows")]
public static void SignFile(string certThumbprint, Uri timestampUrl, string path)
{
SignFile(certThumbprint, timestampUrl, path, null, null);
}
/// <summary>
/// Signs a ClickOnce manifest or PE file.
/// </summary>
/// <param name="certThumbprint">Hexadecimal string that contains the SHA-1 hash of the certificate.</param>
/// <param name="timestampUrl">URL that specifies an address of a time stamping server.</param>
/// <param name="path">Path of the file to sign with the certificate.</param>
/// <param name="targetFrameworkVersion">Version of the .NET Framework for the target.</param>
[SupportedOSPlatform("windows")]
public static void SignFile(string certThumbprint,
Uri timestampUrl,
string path,
string targetFrameworkVersion)
{
SignFile(certThumbprint, timestampUrl, path, targetFrameworkVersion, null);
}
/// <summary>
/// Signs a ClickOnce manifest or PE file.
/// </summary>
/// <param name="certThumbprint">Hexadecimal string that contains the SHA-1 hash of the certificate.</param>
/// <param name="timestampUrl">URL that specifies an address of a time stamping server.</param>
/// <param name="path">Path of the file to sign with the certificate.</param>
/// <param name="targetFrameworkVersion">Version of the .NET Framework for the target.</param>
/// <param name="targetFrameworkIdentifier">.NET Framework identifier for the target.</param>
[SupportedOSPlatform("windows")]
public static void SignFile(string certThumbprint,
Uri timestampUrl,
string path,
string targetFrameworkVersion,
string targetFrameworkIdentifier)
{
SignFile(certThumbprint, timestampUrl, path, targetFrameworkVersion, targetFrameworkIdentifier, false);
}
/// <summary>
/// Signs a ClickOnce manifest or PE file.
/// </summary>
/// <param name="certThumbprint">Hexadecimal string that contains the SHA-1 hash of the certificate.</param>
/// <param name="timestampUrl">URL that specifies an address of a time stamping server.</param>
/// <param name="path">Path of the file to sign with the certificate.</param>
/// <param name="targetFrameworkVersion">Version of the .NET Framework for the target.</param>
/// <param name="targetFrameworkIdentifier">.NET Framework identifier for the target.</param>
/// <param name="disallowMansignTimestampFallback">Disallow fallback to legacy timestamping when RFC3161 timestamping fails during manifest signing</param>
[SupportedOSPlatform("windows")]
public static void SignFile(string certThumbprint,
Uri timestampUrl,
string path,
string targetFrameworkVersion,
string targetFrameworkIdentifier,
bool disallowMansignTimestampFallback)
{
System.Resources.ResourceManager resources = new System.Resources.ResourceManager("Microsoft.Build.Tasks.Core.Strings.ManifestUtilities", typeof(SecurityUtilities).Module.Assembly);
if (String.IsNullOrEmpty(certThumbprint))
{
throw new ArgumentNullException(nameof(certThumbprint));
}
X509Certificate2 cert = GetCert(certThumbprint);
if (cert == null)
{
throw new ArgumentException(resources.GetString("CertNotInStore"), nameof(certThumbprint));
}
if (!String.IsNullOrEmpty(targetFrameworkVersion))
{
Version targetVersion = Util.GetTargetFrameworkVersion(targetFrameworkVersion);
if (targetVersion == null)
{
throw new ArgumentException("TargetFrameworkVersion");
}
bool isTargetFrameworkSha256Supported = false;
if (String.IsNullOrEmpty(targetFrameworkIdentifier) ||
targetFrameworkIdentifier.Equals(Constants.DotNetFrameworkIdentifier, StringComparison.InvariantCultureIgnoreCase))
{
// SHA-256 digest can be parsed only with .NET 4.5 or higher.
isTargetFrameworkSha256Supported = targetVersion.CompareTo(s_dotNet45Version) >= 0;
}
else if (targetFrameworkIdentifier.Equals(Constants.DotNetCoreAppIdentifier, StringComparison.InvariantCultureIgnoreCase))
{
// Use SHA-256 digest for .NET Core apps
isTargetFrameworkSha256Supported = true;
}
SignFileInternal(cert, timestampUrl, path, isTargetFrameworkSha256Supported, resources, disallowMansignTimestampFallback);
}
else
{
SignFile(cert, timestampUrl, path);
}
}
// We need to refactor these functions to handle real sign tool
/// <summary>
/// Signs a ClickOnce manifest.
/// </summary>
/// <param name="certPath">The certificate to be used to sign the file.</param>
/// <param name="certPassword">The certificate password.</param>
/// <param name="timestampUrl">URL that specifies an address of a time stamping server.</param>
/// <param name="path">Path of the file to sign with the certificate.</param>
/// <remarks>This function is only for signing a manifest, not a PE file.</remarks>
[SupportedOSPlatform("windows")]
public static void SignFile(string certPath, SecureString certPassword, Uri timestampUrl, string path)
{
using X509Certificate2 cert = new X509Certificate2(certPath, certPassword, X509KeyStorageFlags.PersistKeySet);
SignFile(cert, timestampUrl, path);
}
private static bool UseSha256Algorithm(X509Certificate2 cert)
{
Oid oid = cert.SignatureAlgorithm;
// Issue 6732: Clickonce does not support sha384/sha512 file hash so we default to sha256
// for certs with that signature algorithm.
return string.Equals(oid.FriendlyName, "sha256RSA", StringComparison.OrdinalIgnoreCase) ||
string.Equals(oid.FriendlyName, "sha384RSA", StringComparison.OrdinalIgnoreCase) ||
string.Equals(oid.FriendlyName, "sha512RSA", StringComparison.OrdinalIgnoreCase);
}
/// <summary>
/// Signs a ClickOnce manifest or PE file.
/// </summary>
/// <param name="cert">The certificate to be used to sign the file.</param>
/// <param name="timestampUrl">URL that specifies an address of a time stamping server.</param>
/// <param name="path">Path of the file to sign with the certificate.</param>
/// <remarks>This function can only sign a PE file if the X509Certificate2 parameter represents a certificate in the
/// current user's personal certificate store.</remarks>
[SupportedOSPlatform("windows")]
public static void SignFile(X509Certificate2 cert, Uri timestampUrl, string path)
{
// setup resources
System.Resources.ResourceManager resources = new System.Resources.ResourceManager("Microsoft.Build.Tasks.Core.Strings.ManifestUtilities", typeof(SecurityUtilities).Module.Assembly);
SignFileInternal(cert, timestampUrl, path, true, resources);
}
[SupportedOSPlatform("windows")]
private static void SignFileInternal(X509Certificate2 cert,
Uri timestampUrl,
string path,
bool targetFrameworkSupportsSha256,
System.Resources.ResourceManager resources,
bool disallowMansignTimestampFallback = false)
{
if (cert == null)
{
throw new ArgumentNullException(nameof(cert));
}
if (String.IsNullOrEmpty(path))
{
throw new ArgumentNullException(nameof(path));
}
if (!FileSystems.Default.FileExists(path))
{
throw new FileNotFoundException(String.Format(CultureInfo.InvariantCulture, resources.GetString("SecurityUtil.SignTargetNotFound"), path), path);
}
bool useSha256 = UseSha256Algorithm(cert) && targetFrameworkSupportsSha256;
if (PathUtil.IsPEFile(path))
{
if (IsCertInStore(cert))
{
SignPEFile(cert, timestampUrl, path, resources, useSha256);
}
else
{
throw new InvalidOperationException(resources.GetString("SignFile.CertNotInStore"));
}
}
else
{
#if RUNTIME_TYPE_NETCORE
IntPtr hModule = IntPtr.Zero;
using (RSA rsa = cert.GetRSAPrivateKey())
#else
using (RSA rsa = CngLightup.GetRSAPrivateKey(cert))
#endif
{
if (rsa == null)
{
throw new ApplicationException(resources.GetString("SecurityUtil.OnlyRSACertsAreAllowed"));
}
try
{
var doc = new XmlDocument { PreserveWhitespace = true };
var xrSettings = new XmlReaderSettings { DtdProcessing = DtdProcessing.Ignore, CloseInput = true };
FileStream fs = File.OpenRead(path);
using (XmlReader xr = XmlReader.Create(fs, xrSettings))
{
doc.Load(xr);
}
var manifest = new SignedCmiManifest2(doc, useSha256);
CmiManifestSigner2 signer;
if (useSha256 && rsa is RSACryptoServiceProvider rsacsp)
{
#pragma warning disable CA2000 // Dispose objects before losing scope because CmiManifestSigner2 will dispose the RSACryptoServiceProvider
signer = new CmiManifestSigner2(SignedCmiManifest2.GetFixedRSACryptoServiceProvider(rsacsp, useSha256), cert, useSha256);
#pragma warning restore CA2000 // Dispose objects before losing scope
}
else
{
signer = new CmiManifestSigner2(rsa, cert, useSha256);
}
#if RUNTIME_TYPE_NETCORE
// Manifest signing uses .NET FX APIs, implemented in clr.dll.
// Load the library explicitly.
string clrDllDir = Path.Combine(
Environment.GetFolderPath(Environment.SpecialFolder.Windows),
"Microsoft.NET",
Environment.Is64BitProcess ? "Framework64" : "Framework",
"v4.0.30319");
NativeMethods.SetDllDirectoryW(clrDllDir);
hModule = NativeMethods.LoadLibraryExW(Path.Combine(clrDllDir, "clr.dll"), IntPtr.Zero, NativeMethods.LOAD_LIBRARY_AS_DATAFILE);
// No need to check hModule - Sign() method will quickly fail if we did not load clr.dll
#endif
if (timestampUrl == null)
{
manifest.Sign(signer);
}
else
{
manifest.Sign(signer, timestampUrl.ToString(), disallowMansignTimestampFallback);
}
doc.Save(path);
}
catch (Exception ex)
{
int exceptionHR = Marshal.GetHRForException(ex);
if (exceptionHR == -2147012889 || exceptionHR == -2147012867)
{
throw new ApplicationException(resources.GetString("SecurityUtil.TimestampUrlNotFound"), ex);
}
throw new ApplicationException(ex.Message, ex);
}
#if RUNTIME_TYPE_NETCORE
finally
{
if (hModule != IntPtr.Zero)
{
NativeMethods.FreeLibrary(hModule);
}
NativeMethods.SetDllDirectoryW(null);
}
#endif
}
}
}
private static void SignPEFile(X509Certificate2 cert, Uri timestampUrl, string path, System.Resources.ResourceManager resources, bool useSha256)
{
try
{
SignPEFileInternal(cert, timestampUrl, path, resources, useSha256, true);
}
catch (ApplicationException) when (timestampUrl != null)
{
// error, retry with signtool /t if timestamp url was given
SignPEFileInternal(cert, timestampUrl, path, resources, useSha256, false);
return;
}
}
private static void SignPEFileInternal(X509Certificate2 cert, Uri timestampUrl,
string path, System.Resources.ResourceManager resources,
bool useSha256, bool useRFC3161Timestamp)
{
var startInfo = new ProcessStartInfo(
GetPathToTool(resources),
GetCommandLineParameters(cert.Thumbprint, timestampUrl, path, useSha256, useRFC3161Timestamp))
{
CreateNoWindow = true,
UseShellExecute = false,
RedirectStandardError = true,
RedirectStandardOutput = true
};
Process signTool = null;
try
{
signTool = Process.Start(startInfo);
signTool.WaitForExit();
while (!signTool.HasExited)
{
System.Threading.Thread.Sleep(50);
}
switch (signTool.ExitCode)
{
case 0:
// everything was fine
break;
case 1:
// error, report it
throw new ApplicationException(String.Format(CultureInfo.InvariantCulture, resources.GetString("SecurityUtil.SigntoolFail"), path, signTool.StandardError.ReadToEnd()));
case 2:
// warning, report it
throw new WarningException(String.Format(CultureInfo.InvariantCulture, resources.GetString("SecurityUtil.SigntoolWarning"), path, signTool.StandardError.ReadToEnd()));
default:
// treat as error
throw new ApplicationException(String.Format(CultureInfo.InvariantCulture, resources.GetString("SecurityUtil.SigntoolFail"), path, signTool.StandardError.ReadToEnd()));
}
}
finally
{
signTool?.Close();
}
}
internal static string GetCommandLineParameters(string certThumbprint, Uri timestampUrl, string path,
bool useSha256, bool useRFC3161Timestamp)
{
var commandLine = new StringBuilder();
if (useSha256)
{
commandLine.AppendFormat(CultureInfo.InvariantCulture, "sign /fd sha256 /sha1 {0} ", certThumbprint);
}
else
{
commandLine.AppendFormat(CultureInfo.InvariantCulture, "sign /sha1 {0} ", certThumbprint);
}
if (timestampUrl != null)
{
commandLine.AppendFormat(CultureInfo.InvariantCulture,
"{0} {1} ",
useRFC3161Timestamp ? "/td sha256 /tr" : "/t",
timestampUrl.ToString());
}
commandLine.AppendFormat(CultureInfo.InvariantCulture, "\"{0}\"", path);
return commandLine.ToString();
}
internal static string GetPathToTool(System.Resources.ResourceManager resources)
{
#pragma warning disable 618 // Disabling warning on using internal ToolLocationHelper API. At some point we should migrate this.
string toolPath = ToolLocationHelper.GetPathToWindowsSdkFile(ToolName, TargetDotNetFrameworkVersion.VersionLatest, VisualStudioVersion.VersionLatest);
if (toolPath == null || !FileSystems.Default.FileExists(toolPath))
{
toolPath = ToolLocationHelper.GetPathToWindowsSdkFile(ToolName, TargetDotNetFrameworkVersion.Version45,
VisualStudioVersion.Version110);
}
if (toolPath == null || !FileSystems.Default.FileExists(toolPath))
{
var pathToDotNetFrameworkSdk = ToolLocationHelper.GetPathToDotNetFrameworkSdk(TargetDotNetFrameworkVersion.Version40, VisualStudioVersion.Version100);
if (pathToDotNetFrameworkSdk != null)
{
toolPath = Path.Combine(pathToDotNetFrameworkSdk, "bin", ToolName);
}
}
if (NativeMethodsShared.IsWindows && (toolPath == null || !FileSystems.Default.FileExists(toolPath)))
{
toolPath = GetVersionIndependentToolPath(ToolName);
}
if (toolPath == null || !FileSystems.Default.FileExists(toolPath))
{
toolPath = Path.Combine(Directory.GetCurrentDirectory(), ToolName);
}
if (!FileSystems.Default.FileExists(toolPath))
{
throw new ApplicationException(String.Format(CultureInfo.CurrentCulture,
resources.GetString("SecurityUtil.SigntoolNotFound"), toolPath));
}
return toolPath;
#pragma warning restore 618
}
internal static X509Certificate2 GetCert(string thumbprint)
{
var personalStore = new X509Store(StoreName.My, StoreLocation.CurrentUser);
try
{
personalStore.Open(OpenFlags.ReadOnly);
X509Certificate2Collection foundCerts = personalStore.Certificates.Find(X509FindType.FindByThumbprint, thumbprint, false);
if (foundCerts.Count == 1)
{
return foundCerts[0];
}
}
finally
{
personalStore.Close();
}
return null;
}
private static bool IsCertInStore(X509Certificate2 cert)
{
var personalStore = new X509Store(StoreName.My, StoreLocation.CurrentUser);
try
{
personalStore.Open(OpenFlags.ReadOnly);
X509Certificate2Collection foundCerts = personalStore.Certificates.Find(X509FindType.FindByThumbprint, cert.Thumbprint, false);
if (foundCerts.Count == 1)
{
return true;
}
}
finally
{
personalStore.Close();
}
return false;
}
[SupportedOSPlatform("windows")]
private static string GetVersionIndependentToolPath(string toolName)
{
const string versionIndependentToolKeyName = @"Software\Microsoft\ClickOnce\SignTool";
using (RegistryKey localMachineKey = RegistryKey.OpenBaseKey(RegistryHive.LocalMachine, RegistryView.Registry32))
{
using (RegistryKey versionIndependentToolKey = localMachineKey.OpenSubKey(versionIndependentToolKeyName, writable: false))
{
string versionIndependentToolPath = null;
if (versionIndependentToolKey != null)
{
versionIndependentToolPath = versionIndependentToolKey.GetValue("Path") as string;
}
return versionIndependentToolPath != null ? Path.Combine(versionIndependentToolPath, toolName) : null;
}
}
}
}
}
|