2 // X509Certificate.cs: Handles X.509 certificates.
5 // Sebastien Pouliot <sebastien@ximian.com>
7 // (C) 2002, 2003 Motus Technologies Inc. (http://www.motus.com)
8 // Copyright (C) 2004-2006 Novell, Inc (http://www.novell.com)
10 // Permission is hereby granted, free of charge, to any person obtaining
11 // a copy of this software and associated documentation files (the
12 // "Software"), to deal in the Software without restriction, including
13 // without limitation the rights to use, copy, modify, merge, publish,
14 // distribute, sublicense, and/or sell copies of the Software, and to
15 // permit persons to whom the Software is furnished to do so, subject to
16 // the following conditions:
18 // The above copyright notice and this permission notice shall be
19 // included in all copies or substantial portions of the Software.
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 using System.Runtime.InteropServices;
32 using System.Security.Permissions;
36 using Mono.Security.X509;
38 using System.Runtime.Serialization;
40 using Mono.Security.Authenticode;
43 namespace System.Security.Cryptography.X509Certificates {
46 // a. Internet X.509 Public Key Infrastructure Certificate and CRL Profile
47 // http://www.ietf.org/rfc/rfc3280.txt
49 // LAMESPEC: the MSDN docs always talks about X509v3 certificates
50 // and/or Authenticode certs. However this class works with older
51 // X509v1 certificates and non-authenticode (code signing) certs.
54 public partial class X509Certificate {
56 public partial class X509Certificate : IDeserializationCallback, ISerializable {
58 // typedef struct _CERT_CONTEXT {
59 // DWORD dwCertEncodingType;
60 // BYTE *pbCertEncoded;
61 // DWORD cbCertEncoded;
62 // PCERT_INFO pCertInfo;
63 // HCERTSTORE hCertStore;
64 // } CERT_CONTEXT, *PCERT_CONTEXT;
65 // typedef const CERT_CONTEXT *PCCERT_CONTEXT;
66 [StructLayout (LayoutKind.Sequential)]
67 internal struct CertificateContext {
68 public UInt32 dwCertEncodingType;
69 public IntPtr pbCertEncoded;
70 public UInt32 cbCertEncoded;
71 public IntPtr pCertInfo;
72 public IntPtr hCertStore;
74 // NOTE: We only define the CryptoAPI structure (from WINCRYPT.H)
75 // so we don't create any dependencies on Windows DLL in corlib
77 private Mono.Security.X509.X509Certificate x509;
78 private bool hideDates;
79 private byte[] cachedCertificateHash;
81 // almost every byte[] returning function has a string equivalent
82 // sadly the BitConverter insert dash between bytes :-(
83 private string tostr (byte[] data)
86 StringBuilder sb = new StringBuilder ();
87 for (int i = 0; i < data.Length; i++)
88 sb.Append (data[i].ToString ("X2"));
89 return sb.ToString ();
97 public static X509Certificate CreateFromCertFile (string filename)
99 byte[] data = Load (filename);
100 return new X509Certificate (data);
104 [MonoTODO ("Incomplete - minimal validation in this version")]
105 public static X509Certificate CreateFromSignedFile (string filename)
108 AuthenticodeDeformatter a = new AuthenticodeDeformatter (filename);
109 if (a.SigningCertificate != null) {
110 return new X509Certificate (a.SigningCertificate.RawData);
113 catch (SecurityException) {
114 // don't wrap SecurityException into a COMException
117 catch (Exception e) {
118 string msg = Locale.GetText ("Couldn't extract digital signature from {0}.", filename);
119 throw new COMException (msg, e);
121 throw new CryptographicException (Locale.GetText ("{0} isn't signed.", filename));
128 // special constructor for Publisher (and related classes).
129 // Dates strings are null
130 internal X509Certificate (byte[] data, bool dates)
133 Import (data, (string)null, X509KeyStorageFlags.DefaultKeySet);
138 public X509Certificate (byte[] data) : this (data, true)
142 public X509Certificate (IntPtr handle)
144 if (handle == IntPtr.Zero)
145 throw new ArgumentException ("Invalid handle.");
147 // this works on Windows-only so it's of no use for Moonlight
148 // even more since this ctor is [SecurityCritical]
149 throw new NotSupportedException ();
151 InitFromHandle (handle);
156 [SecurityPermission (SecurityAction.Demand, UnmanagedCode = true)]
157 private void InitFromHandle (IntPtr handle)
159 if (handle != IntPtr.Zero) {
160 // both Marshal.PtrToStructure and Marshal.Copy use LinkDemand (so they will always success from here)
161 CertificateContext cc = (CertificateContext) Marshal.PtrToStructure (handle, typeof (CertificateContext));
162 byte[] data = new byte [cc.cbCertEncoded];
163 Marshal.Copy (cc.pbCertEncoded, data, 0, (int)cc.cbCertEncoded);
164 x509 = new Mono.Security.X509.X509Certificate (data);
166 // for 1.x IntPtr.Zero results in an "empty" certificate instance
170 public X509Certificate (System.Security.Cryptography.X509Certificates.X509Certificate cert)
173 throw new ArgumentNullException ("cert");
176 byte[] data = cert.GetRawCertData ();
178 x509 = new Mono.Security.X509.X509Certificate (data);
186 public virtual bool Equals (System.Security.Cryptography.X509Certificates.X509Certificate other)
191 if (other.x509 == null) {
194 throw new CryptographicException (Locale.GetText ("Certificate instance is empty."));
197 byte[] raw = other.x509.RawData;
201 if (x509.RawData == null)
203 if (raw.Length == x509.RawData.Length) {
204 for (int i = 0; i < raw.Length; i++) {
205 if (raw[i] != x509.RawData [i])
208 // well no choice must be equals!
215 return ((x509 == null) || (x509.RawData == null));
218 // LAMESPEC: This is the equivalent of the "thumbprint" that can be seen
219 // in the certificate viewer of Windows. This is ALWAYS the SHA1 hash of
220 // the certificate (i.e. it has nothing to do with the actual hash
221 // algorithm used to sign the certificate).
222 public virtual byte[] GetCertHash ()
225 throw new CryptographicException (Locale.GetText ("Certificate instance is empty."));
226 // we'll hash the cert only once and only if required
227 if ((cachedCertificateHash == null) && (x509 != null)) {
228 SHA1 sha = SHA1.Create ();
229 cachedCertificateHash = sha.ComputeHash (x509.RawData);
231 return cachedCertificateHash;
234 public virtual string GetCertHashString ()
236 // must call GetCertHash (not variable) or optimization wont work
237 return tostr (GetCertHash ());
240 // strangly there are no DateTime returning function
241 public virtual string GetEffectiveDateString ()
246 throw new CryptographicException (Locale.GetText ("Certificate instance is empty."));
248 return x509.ValidFrom.ToLocalTime ().ToString ();
251 // strangly there are no DateTime returning function
252 public virtual string GetExpirationDateString ()
257 throw new CryptographicException (Locale.GetText ("Certificate instance is empty."));
259 return x509.ValidUntil.ToLocalTime ().ToString ();
262 // well maybe someday there'll be support for PGP or SPKI ?
263 public virtual string GetFormat ()
265 return "X509"; // DO NOT TRANSLATE
268 public override int GetHashCode ()
272 // the cert hash may not be (yet) calculated
273 if (cachedCertificateHash == null)
276 // return the integer of the first 4 bytes of the cert hash
277 if ((cachedCertificateHash != null) && (cachedCertificateHash.Length >= 4))
278 return ((cachedCertificateHash[0] << 24) |(cachedCertificateHash[1] << 16) |
279 (cachedCertificateHash[2] << 8) | cachedCertificateHash[3]);
284 [Obsolete ("Use the Issuer property.")]
285 public virtual string GetIssuerName ()
288 throw new CryptographicException (Locale.GetText ("Certificate instance is empty."));
289 return x509.IssuerName;
292 public virtual string GetKeyAlgorithm ()
295 throw new CryptographicException (Locale.GetText ("Certificate instance is empty."));
296 return x509.KeyAlgorithm;
299 public virtual byte[] GetKeyAlgorithmParameters ()
302 throw new CryptographicException (Locale.GetText ("Certificate instance is empty."));
304 byte[] kap = x509.KeyAlgorithmParameters;
306 throw new CryptographicException (Locale.GetText ("Parameters not part of the certificate"));
311 public virtual string GetKeyAlgorithmParametersString ()
313 return tostr (GetKeyAlgorithmParameters ());
316 [Obsolete ("Use the Subject property.")]
317 public virtual string GetName ()
320 throw new CryptographicException (Locale.GetText ("Certificate instance is empty."));
321 return x509.SubjectName;
324 public virtual byte[] GetPublicKey ()
327 throw new CryptographicException (Locale.GetText ("Certificate instance is empty."));
328 return x509.PublicKey;
331 public virtual string GetPublicKeyString ()
333 return tostr (GetPublicKey ());
336 public virtual byte[] GetRawCertData ()
339 throw new CryptographicException (Locale.GetText ("Certificate instance is empty."));
343 public virtual string GetRawCertDataString ()
346 throw new CryptographicException (Locale.GetText ("Certificate instance is empty."));
347 return tostr (x509.RawData);
350 public virtual byte[] GetSerialNumber ()
353 throw new CryptographicException (Locale.GetText ("Certificate instance is empty."));
354 return x509.SerialNumber;
357 public virtual string GetSerialNumberString ()
359 byte[] sn = GetSerialNumber ();
364 // to please corcompare ;-)
365 public override string ToString ()
367 return base.ToString ();
370 public virtual string ToString (bool fVerbose)
372 if (!fVerbose || (x509 == null))
373 return base.ToString ();
375 string nl = Environment.NewLine;
376 StringBuilder sb = new StringBuilder ();
377 sb.AppendFormat ("[Subject]{0} {1}{0}{0}", nl, Subject);
378 sb.AppendFormat ("[Issuer]{0} {1}{0}{0}", nl, Issuer);
379 sb.AppendFormat ("[Not Before]{0} {1}{0}{0}", nl, GetEffectiveDateString ());
380 sb.AppendFormat ("[Not After]{0} {1}{0}{0}", nl, GetExpirationDateString ());
381 sb.AppendFormat ("[Thumbprint]{0} {1}{0}", nl, GetCertHashString ());
383 return sb.ToString ();
386 private static byte[] Load (string fileName)
389 using (FileStream fs = File.OpenRead (fileName)) {
390 data = new byte [fs.Length];
391 fs.Read (data, 0, data.Length);