//------------------------------------------------------------ // Copyright (c) Microsoft Corporation. All rights reserved. //------------------------------------------------------------ namespace System.IdentityModel.Claims { using System.Collections.Generic; using System.Diagnostics; using System.IdentityModel.Policy; using System.Net.Mail; using System.Security.Claims; using System.Security.Cryptography; using System.Security.Cryptography.X509Certificates; using System.Security.Principal; using Globalization; public class X509CertificateClaimSet : ClaimSet, IIdentityInfo, IDisposable { X509Certificate2 certificate; DateTime expirationTime = SecurityUtils.MinUtcDateTime; ClaimSet issuer; X509Identity identity; X509ChainElementCollection elements; IList claims; int index; bool disposed = false; public X509CertificateClaimSet(X509Certificate2 certificate) : this(certificate, true) { } internal X509CertificateClaimSet(X509Certificate2 certificate, bool clone) { if (certificate == null) throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("certificate"); this.certificate = clone ? new X509Certificate2(certificate) : certificate; } X509CertificateClaimSet(X509CertificateClaimSet from) : this(from.X509Certificate, true) { } X509CertificateClaimSet(X509ChainElementCollection elements, int index) { this.elements = elements; this.index = index; this.certificate = elements[index].Certificate; } public override Claim this[int index] { get { ThrowIfDisposed(); EnsureClaims(); return this.claims[index]; } } public override int Count { get { ThrowIfDisposed(); EnsureClaims(); return this.claims.Count; } } IIdentity IIdentityInfo.Identity { get { ThrowIfDisposed(); if (this.identity == null) this.identity = new X509Identity(this.certificate, false, false); return this.identity; } } public DateTime ExpirationTime { get { ThrowIfDisposed(); if (this.expirationTime == SecurityUtils.MinUtcDateTime) this.expirationTime = this.certificate.NotAfter.ToUniversalTime(); return this.expirationTime; } } public override ClaimSet Issuer { get { ThrowIfDisposed(); if (this.issuer == null) { if (this.elements == null) { X509Chain chain = new X509Chain(); chain.ChainPolicy.RevocationMode = X509RevocationMode.NoCheck; chain.Build(certificate); this.index = 0; this.elements = chain.ChainElements; } if (this.index + 1 < this.elements.Count) { this.issuer = new X509CertificateClaimSet(this.elements, this.index + 1); this.elements = null; } // SelfSigned? else if (StringComparer.OrdinalIgnoreCase.Equals(this.certificate.SubjectName.Name, this.certificate.IssuerName.Name)) this.issuer = this; else this.issuer = new X500DistinguishedNameClaimSet(this.certificate.IssuerName); } return this.issuer; } } public X509Certificate2 X509Certificate { get { ThrowIfDisposed(); return this.certificate; } } internal X509CertificateClaimSet Clone() { ThrowIfDisposed(); return new X509CertificateClaimSet(this); } public void Dispose() { if (!this.disposed) { this.disposed = true; SecurityUtils.DisposeIfNecessary(this.identity); if (this.issuer != null) { if (this.issuer != this) { SecurityUtils.DisposeIfNecessary(this.issuer as IDisposable); } } if (this.elements != null) { for (int i = this.index + 1; i < this.elements.Count; ++i) { SecurityUtils.ResetCertificate(this.elements[i].Certificate); } } SecurityUtils.ResetCertificate(this.certificate); } } IList InitializeClaimsCore() { List claims = new List(); byte[] thumbprint = this.certificate.GetCertHash(); claims.Add(new Claim(ClaimTypes.Thumbprint, thumbprint, Rights.Identity)); claims.Add(new Claim(ClaimTypes.Thumbprint, thumbprint, Rights.PossessProperty)); // Ordering SubjectName, Dns, SimpleName, Email, Upn string value = this.certificate.SubjectName.Name; if (!string.IsNullOrEmpty(value)) claims.Add(Claim.CreateX500DistinguishedNameClaim(this.certificate.SubjectName)); claims.AddRange(GetDnsClaims(this.certificate)); value = this.certificate.GetNameInfo(X509NameType.SimpleName, false); if (!string.IsNullOrEmpty(value)) claims.Add(Claim.CreateNameClaim(value)); value = this.certificate.GetNameInfo(X509NameType.EmailName, false); if (!string.IsNullOrEmpty(value)) claims.Add(Claim.CreateMailAddressClaim(new MailAddress(value))); value = this.certificate.GetNameInfo(X509NameType.UpnName, false); if (!string.IsNullOrEmpty(value)) claims.Add(Claim.CreateUpnClaim(value)); value = this.certificate.GetNameInfo(X509NameType.UrlName, false); if (!string.IsNullOrEmpty(value)) claims.Add(Claim.CreateUriClaim(new Uri(value))); RSA rsa = this.certificate.PublicKey.Key as RSA; if (rsa != null) claims.Add(Claim.CreateRsaClaim(rsa)); return claims; } void EnsureClaims() { if (this.claims != null) return; this.claims = InitializeClaimsCore(); } static bool SupportedClaimType(string claimType) { return claimType == null || ClaimTypes.Thumbprint.Equals(claimType) || ClaimTypes.X500DistinguishedName.Equals(claimType) || ClaimTypes.Dns.Equals(claimType) || ClaimTypes.Name.Equals(claimType) || ClaimTypes.Email.Equals(claimType) || ClaimTypes.Upn.Equals(claimType) || ClaimTypes.Uri.Equals(claimType) || ClaimTypes.Rsa.Equals(claimType); } // Note: null string represents any. public override IEnumerable FindClaims(string claimType, string right) { ThrowIfDisposed(); if (!SupportedClaimType(claimType) || !ClaimSet.SupportedRight(right)) { yield break; } else if (this.claims == null && ClaimTypes.Thumbprint.Equals(claimType)) { if (right == null || Rights.Identity.Equals(right)) { yield return new Claim(ClaimTypes.Thumbprint, this.certificate.GetCertHash(), Rights.Identity); } if (right == null || Rights.PossessProperty.Equals(right)) { yield return new Claim(ClaimTypes.Thumbprint, this.certificate.GetCertHash(), Rights.PossessProperty); } } else if (this.claims == null && ClaimTypes.Dns.Equals(claimType)) { if (right == null || Rights.PossessProperty.Equals(right)) { foreach (var claim in GetDnsClaims(certificate)) yield return claim; } } else { EnsureClaims(); bool anyClaimType = (claimType == null); bool anyRight = (right == null); for (int i = 0; i < this.claims.Count; ++i) { Claim claim = this.claims[i]; if ((claim != null) && (anyClaimType || claimType.Equals(claim.ClaimType)) && (anyRight || right.Equals(claim.Right))) { yield return claim; } } } } private static List GetDnsClaims(X509Certificate2 cert) { List dnsClaimEntries = new List(); // old behavior, default for <= 4.6 string value = cert.GetNameInfo(X509NameType.DnsName, false); if (!string.IsNullOrEmpty(value)) dnsClaimEntries.Add(Claim.CreateDnsClaim(value)); // App context switch for disabling support for multiple dns entries in a SAN certificate // If we can't dynamically parse the alt subject names, we will not add any dns claims ONLY for the alt subject names. // In this way, if the X509NameType.DnsName was enough to succeed for the out-bound-message. We would have a success. if (!LocalAppContextSwitches.DisableMultipleDNSEntriesInSANCertificate && X509SubjectAlternativeNameConstants.SuccessfullyInitialized) { foreach (X509Extension ext in cert.Extensions) { // Extension is SAN or SAN2 if (ext.Oid.Value == X509SubjectAlternativeNameConstants.SanOid || ext.Oid.Value == X509SubjectAlternativeNameConstants.San2Oid) { string asnString = ext.Format(false); if (string.IsNullOrWhiteSpace(asnString)) break; // SubjectAlternativeNames might contain something other than a dNSName, // so we have to parse through and only use the dNSNames // string[] rawDnsEntries = asnString.Split(X509SubjectAlternativeNameConstants.SeparatorArray, StringSplitOptions.RemoveEmptyEntries); for (int i = 0; i < rawDnsEntries.Length; i++) { string[] keyval = rawDnsEntries[i].Split(X509SubjectAlternativeNameConstants.Delimiter); if (string.Equals(keyval[0], X509SubjectAlternativeNameConstants.Identifier)) dnsClaimEntries.Add(Claim.CreateDnsClaim(keyval[1])); } } } } return dnsClaimEntries; } public override IEnumerator GetEnumerator() { ThrowIfDisposed(); EnsureClaims(); return this.claims.GetEnumerator(); } public override string ToString() { return this.disposed ? base.ToString() : SecurityUtils.ClaimSetToString(this); } void ThrowIfDisposed() { if (this.disposed) { throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(new ObjectDisposedException(this.GetType().FullName)); } } class X500DistinguishedNameClaimSet : DefaultClaimSet, IIdentityInfo { IIdentity identity; public X500DistinguishedNameClaimSet(X500DistinguishedName x500DistinguishedName) { if (x500DistinguishedName == null) throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("x500DistinguishedName"); this.identity = new X509Identity(x500DistinguishedName); List claims = new List(2); claims.Add(new Claim(ClaimTypes.X500DistinguishedName, x500DistinguishedName, Rights.Identity)); claims.Add(Claim.CreateX500DistinguishedNameClaim(x500DistinguishedName)); Initialize(ClaimSet.Anonymous, claims); } public IIdentity Identity { get { return this.identity; } } } // We don't have a strongly typed extension to parse Subject Alt Names, so we have to do a workaround // to figure out what the identifier, delimiter, and separator is by using a well-known extension private static class X509SubjectAlternativeNameConstants { public const string SanOid = "2.5.29.7"; public const string San2Oid = "2.5.29.17"; public static string Identifier { get; private set; } public static char Delimiter { get; private set; } public static string Separator { get; private set; } public static string[] SeparatorArray { get; private set; } public static bool SuccessfullyInitialized { get; private set; } // static initializer will run before properties are accessed static X509SubjectAlternativeNameConstants() { // Extracted a well-known X509Extension byte[] x509ExtensionBytes = new byte[] { 48, 36, 130, 21, 110, 111, 116, 45, 114, 101, 97, 108, 45, 115, 117, 98, 106, 101, 99, 116, 45, 110, 97, 109, 101, 130, 11, 101, 120, 97, 109, 112, 108, 101, 46, 99, 111, 109 }; const string subjectName = "not-real-subject-name"; string x509ExtensionFormattedString = string.Empty; try { X509Extension x509Extension = new X509Extension(SanOid, x509ExtensionBytes, true); x509ExtensionFormattedString = x509Extension.Format(false); // Each OS has a different dNSName identifier and delimiter // On Windows, dNSName == "DNS Name" (localizable), on Linux, dNSName == "DNS" // e.g., // Windows: x509ExtensionFormattedString is: "DNS Name=not-real-subject-name, DNS Name=example.com" // Linux: x509ExtensionFormattedString is: "DNS:not-real-subject-name, DNS:example.com" // Parse: int delimiterIndex = x509ExtensionFormattedString.IndexOf(subjectName) - 1; Delimiter = x509ExtensionFormattedString[delimiterIndex]; // Make an assumption that all characters from the the start of string to the delimiter // are part of the identifier Identifier = x509ExtensionFormattedString.Substring(0, delimiterIndex); int separatorFirstChar = delimiterIndex + subjectName.Length + 1; int separatorLength = 1; for (int i = separatorFirstChar + 1; i < x509ExtensionFormattedString.Length; i++) { // We advance until the first character of the identifier to determine what the // separator is. This assumes that the identifier assumption above is correct if (x509ExtensionFormattedString[i] == Identifier[0]) { break; } separatorLength++; } Separator = x509ExtensionFormattedString.Substring(separatorFirstChar, separatorLength); SeparatorArray = new string[1] { Separator }; SuccessfullyInitialized = true; } catch (Exception ex) { SuccessfullyInitialized = false; DiagnosticUtility.TraceHandledException( new FormatException(string.Format(CultureInfo.InvariantCulture, "There was an error parsing the SubjectAlternativeNames: '{0}'. See inner exception for more details.{1}Detected values were: Identifier: '{2}'; Delimiter:'{3}'; Separator:'{4}'", x509ExtensionFormattedString, Environment.NewLine, Identifier, Delimiter, Separator), ex), TraceEventType.Warning); } } } } class X509Identity : GenericIdentity, IDisposable { const string X509 = "X509"; const string Thumbprint = "; "; X500DistinguishedName x500DistinguishedName; X509Certificate2 certificate; string name; bool disposed = false; bool disposable = true; public X509Identity(X509Certificate2 certificate) : this(certificate, true, true) { } public X509Identity(X500DistinguishedName x500DistinguishedName) : base(X509, X509) { this.x500DistinguishedName = x500DistinguishedName; } internal X509Identity(X509Certificate2 certificate, bool clone, bool disposable) : base(X509, X509) { this.certificate = clone ? new X509Certificate2(certificate) : certificate; this.disposable = clone || disposable; } public override string Name { get { ThrowIfDisposed(); if (this.name == null) { // // DCR 48092: PrincipalPermission authorization using certificates could cause Elevation of Privilege. // because there could be duplicate subject name. In order to be more unique, we use SubjectName + Thumbprint // instead // this.name = GetName() + Thumbprint + this.certificate.Thumbprint; } return this.name; } } string GetName() { if (this.x500DistinguishedName != null) return this.x500DistinguishedName.Name; string value = this.certificate.SubjectName.Name; if (!string.IsNullOrEmpty(value)) return value; value = this.certificate.GetNameInfo(X509NameType.DnsName, false); if (!string.IsNullOrEmpty(value)) return value; value = this.certificate.GetNameInfo(X509NameType.SimpleName, false); if (!string.IsNullOrEmpty(value)) return value; value = this.certificate.GetNameInfo(X509NameType.EmailName, false); if (!string.IsNullOrEmpty(value)) return value; value = this.certificate.GetNameInfo(X509NameType.UpnName, false); if (!string.IsNullOrEmpty(value)) return value; return String.Empty; } public override ClaimsIdentity Clone() { return this.certificate != null ? new X509Identity(this.certificate) : new X509Identity(this.x500DistinguishedName); } public void Dispose() { if (this.disposable && !this.disposed) { this.disposed = true; if (this.certificate != null) { this.certificate.Reset(); } } } void ThrowIfDisposed() { if (this.disposed) { throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(new ObjectDisposedException(this.GetType().FullName)); } } } }