81af6d0aa2457f7fffdba51c700f2e6a25d6634f
[mono.git] / mcs / class / Mono.Security / Mono.Security.X509 / X509Certificate.cs
1 //
2 // X509Certificates.cs: Handles X.509 certificates.
3 //
4 // Author:
5 //      Sebastien Pouliot  <sebastien@ximian.com>
6 //
7 // (C) 2002, 2003 Motus Technologies Inc. (http://www.motus.com)
8 // Copyright (C) 2004-2006 Novell, Inc (http://www.novell.com)
9 //
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:
17 // 
18 // The above copyright notice and this permission notice shall be
19 // included in all copies or substantial portions of the Software.
20 // 
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.
28 //
29
30 using System;
31 using System.Runtime.Serialization;
32 using System.Security.Cryptography;
33 using SSCX = System.Security.Cryptography.X509Certificates;
34 using System.Security.Permissions;
35 using System.Text;
36
37 namespace Mono.Security.X509 {
38
39         // References:
40         // a.   Internet X.509 Public Key Infrastructure Certificate and CRL Profile
41         //      http://www.ietf.org/rfc/rfc3280.txt
42         // b.   ITU ASN.1 standards (free download)
43         //      http://www.itu.int/ITU-T/studygroups/com17/languages/
44
45 #if INSIDE_CORLIB
46         internal class X509Certificate : ISerializable {
47 #elif NET_2_0
48         public class X509Certificate : ISerializable {
49 #else
50         public class X509Certificate {
51 #endif
52
53                 private ASN1 decoder;
54
55                 private byte[] m_encodedcert;
56                 private DateTime m_from;
57                 private DateTime m_until;
58                 private ASN1 issuer;
59                 private string m_issuername;
60                 private string m_keyalgo;
61                 private byte[] m_keyalgoparams;
62                 private ASN1 subject;
63                 private string m_subject;
64                 private byte[] m_publickey;
65                 private byte[] signature;
66                 private string m_signaturealgo;
67                 private byte[] m_signaturealgoparams;
68                 private byte[] certhash;
69                 private RSA _rsa;
70                 private DSA _dsa;
71                 
72                 // from http://www.ietf.org/rfc/rfc2459.txt
73                 //
74                 //Certificate  ::=  SEQUENCE  {
75                 //     tbsCertificate       TBSCertificate,
76                 //     signatureAlgorithm   AlgorithmIdentifier,
77                 //     signature            BIT STRING  }
78                 //
79                 //TBSCertificate  ::=  SEQUENCE  {
80                 //     version         [0]  Version DEFAULT v1,
81                 //     serialNumber         CertificateSerialNumber,
82                 //     signature            AlgorithmIdentifier,
83                 //     issuer               Name,
84                 //     validity             Validity,
85                 //     subject              Name,
86                 //     subjectPublicKeyInfo SubjectPublicKeyInfo,
87                 //     issuerUniqueID  [1]  IMPLICIT UniqueIdentifier OPTIONAL,
88                 //                          -- If present, version shall be v2 or v3
89                 //     subjectUniqueID [2]  IMPLICIT UniqueIdentifier OPTIONAL,
90                 //                          -- If present, version shall be v2 or v3
91                 //     extensions      [3]  Extensions OPTIONAL
92                 //                          -- If present, version shall be v3 --  }
93                 private int version;
94                 private byte[] serialnumber;
95
96                 private byte[] issuerUniqueID;
97                 private byte[] subjectUniqueID;
98                 private X509ExtensionCollection extensions;
99
100                 private static string encoding_error = Locale.GetText ("Input data cannot be coded as a valid certificate.");
101
102
103                 // that's were the real job is!
104                 private void Parse (byte[] data) 
105                 {
106                         try {
107                                 decoder = new ASN1 (data);
108                                 // Certificate 
109                                 if (decoder.Tag != 0x30)
110                                         throw new CryptographicException (encoding_error);
111                                 // Certificate / TBSCertificate
112                                 if (decoder [0].Tag != 0x30)
113                                         throw new CryptographicException (encoding_error);
114
115                                 ASN1 tbsCertificate = decoder [0];
116
117                                 int tbs = 0;
118                                 // Certificate / TBSCertificate / Version
119                                 ASN1 v = decoder [0][tbs];
120                                 version = 1;                    // DEFAULT v1
121                                 if ((v.Tag == 0xA0) && (v.Count > 0)) {
122                                         // version (optional) is present only in v2+ certs
123                                         version += v [0].Value [0];     // zero based
124                                         tbs++;
125                                 }
126
127                                 // Certificate / TBSCertificate / CertificateSerialNumber
128                                 ASN1 sn = decoder [0][tbs++];
129                                 if (sn.Tag != 0x02) 
130                                         throw new CryptographicException (encoding_error);
131                                 serialnumber = sn.Value;
132                                 Array.Reverse (serialnumber, 0, serialnumber.Length);
133                 
134                                 // Certificate / TBSCertificate / AlgorithmIdentifier
135                                 tbs++;
136                                 // ASN1 signatureAlgo = tbsCertificate.Element (tbs++, 0x30); 
137                 
138                                 issuer = tbsCertificate.Element (tbs++, 0x30); 
139                                 m_issuername = X501.ToString (issuer);
140                 
141                                 ASN1 validity = tbsCertificate.Element (tbs++, 0x30);
142                                 ASN1 notBefore = validity [0];
143                                 m_from = ASN1Convert.ToDateTime (notBefore);
144                                 ASN1 notAfter = validity [1];
145                                 m_until = ASN1Convert.ToDateTime (notAfter);
146                 
147                                 subject = tbsCertificate.Element (tbs++, 0x30);
148                                 m_subject = X501.ToString (subject);
149                 
150                                 ASN1 subjectPublicKeyInfo = tbsCertificate.Element (tbs++, 0x30);
151                 
152                                 ASN1 algorithm = subjectPublicKeyInfo.Element (0, 0x30);
153                                 ASN1 algo = algorithm.Element (0, 0x06);
154                                 m_keyalgo = ASN1Convert.ToOid (algo);
155                                 // parameters ANY DEFINED BY algorithm OPTIONAL
156                                 // so we dont ask for a specific (Element) type and return DER
157                                 ASN1 parameters = algorithm [1];
158                                 m_keyalgoparams = ((algorithm.Count > 1) ? parameters.GetBytes () : null);
159                 
160                                 ASN1 subjectPublicKey = subjectPublicKeyInfo.Element (1, 0x03); 
161                                 // we must drop th first byte (which is the number of unused bits
162                                 // in the BITSTRING)
163                                 int n = subjectPublicKey.Length - 1;
164                                 m_publickey = new byte [n];
165                                 Buffer.BlockCopy (subjectPublicKey.Value, 1, m_publickey, 0, n);
166
167                                 // signature processing
168                                 byte[] bitstring = decoder [2].Value;
169                                 // first byte contains unused bits in first byte
170                                 signature = new byte [bitstring.Length - 1];
171                                 Buffer.BlockCopy (bitstring, 1, signature, 0, signature.Length);
172
173                                 algorithm = decoder [1];
174                                 algo = algorithm.Element (0, 0x06);
175                                 m_signaturealgo = ASN1Convert.ToOid (algo);
176                                 parameters = algorithm [1];
177                                 if (parameters != null)
178                                         m_signaturealgoparams = parameters.GetBytes ();
179                                 else
180                                         m_signaturealgoparams = null;
181
182                                 // Certificate / TBSCertificate / issuerUniqueID
183                                 ASN1 issuerUID = tbsCertificate.Element (tbs, 0x81);
184                                 if (issuerUID != null) {
185                                         tbs++;
186                                         issuerUniqueID = issuerUID.Value;
187                                 }
188
189                                 // Certificate / TBSCertificate / subjectUniqueID
190                                 ASN1 subjectUID = tbsCertificate.Element (tbs, 0x82);
191                                 if (subjectUID != null) {
192                                         tbs++;
193                                         subjectUniqueID = subjectUID.Value;
194                                 }
195
196                                 // Certificate / TBSCertificate / Extensions
197                                 ASN1 extns = tbsCertificate.Element (tbs, 0xA3);
198                                 if ((extns != null) && (extns.Count == 1))
199                                         extensions = new X509ExtensionCollection (extns [0]);
200                                 else
201                                         extensions = new X509ExtensionCollection (null);
202
203                                 // keep a copy of the original data
204                                 m_encodedcert = (byte[]) data.Clone ();
205                         }
206                         catch (Exception ex) {
207                                 throw new CryptographicException (encoding_error, ex);
208                         }
209                 }
210
211                 // constructors
212
213                 public X509Certificate (byte[] data) 
214                 {
215                         if (data != null) {
216                                 // does it looks like PEM ?
217                                 if ((data.Length > 0) && (data [0] == 0x2D)) {
218                                         try {
219                                                 data = PEM ("CERTIFICATE", data);
220                                         }
221                                         catch (Exception ex) {
222                                                 throw new CryptographicException (encoding_error, ex);
223                                         }
224                                 }
225                                 Parse (data);
226                         }
227                 }
228
229                 private byte[] GetUnsignedBigInteger (byte[] integer) 
230                 {
231                         if (integer [0] == 0x00) {
232                                 // this first byte is added so we're sure it's an unsigned integer
233                                 // however we can't feed it into RSAParameters or DSAParameters
234                                 int length = integer.Length - 1;
235                                 byte[] uinteger = new byte [length];
236                                 Buffer.BlockCopy (integer, 1, uinteger, 0, length);
237                                 return uinteger;
238                         }
239                         else
240                                 return integer;
241                 }
242
243                 // public methods
244
245                 public DSA DSA {
246                         get {
247                                 if (m_keyalgoparams == null)
248                                         throw new CryptographicException ("Missing key algorithm parameters.");
249
250                                 if (_dsa == null) {
251                                         DSAParameters dsaParams = new DSAParameters ();
252                                         // for DSA m_publickey contains 1 ASN.1 integer - Y
253                                         ASN1 pubkey = new ASN1 (m_publickey);
254                                         if ((pubkey == null) || (pubkey.Tag != 0x02))
255                                                 return null;
256                                         dsaParams.Y = GetUnsignedBigInteger (pubkey.Value);
257
258                                         ASN1 param = new ASN1 (m_keyalgoparams);
259                                         if ((param == null) || (param.Tag != 0x30) || (param.Count < 3))
260                                                 return null;
261                                         if ((param [0].Tag != 0x02) || (param [1].Tag != 0x02) || (param [2].Tag != 0x02))
262                                                 return null;
263                                         dsaParams.P = GetUnsignedBigInteger (param [0].Value);
264                                         dsaParams.Q = GetUnsignedBigInteger (param [1].Value);
265                                         dsaParams.G = GetUnsignedBigInteger (param [2].Value);
266
267                                         // BUG: MS BCL 1.0 can't import a key which 
268                                         // isn't the same size as the one present in
269                                         // the container.
270                                         _dsa = (DSA) new DSACryptoServiceProvider (dsaParams.Y.Length << 3);
271                                         _dsa.ImportParameters (dsaParams);
272                                 }
273                                 return _dsa; 
274                         }
275 #if NET_2_0
276                         set {
277                                 _dsa = value;
278                                 if (value != null)
279                                         _rsa = null;
280                         }
281 #endif
282                 }
283
284                 public X509ExtensionCollection Extensions {
285                         get { return extensions; }
286                 }
287
288                 public byte[] Hash {
289                         get {
290                                 if (certhash == null) {
291                                         HashAlgorithm hash = null;
292                                         switch (m_signaturealgo) {
293                                                 case "1.2.840.113549.1.1.2":    // MD2 with RSA encryption 
294                                                         // maybe someone installed MD2 ?
295 #if INSIDE_CORLIB
296                                                         hash = HashAlgorithm.Create ("MD2");
297 #else
298                                                         hash = Mono.Security.Cryptography.MD2.Create ();
299 #endif
300                                                         break;
301                                                 case "1.2.840.113549.1.1.4":    // MD5 with RSA encryption 
302                                                         hash = MD5.Create ();
303                                                         break;
304                                                 case "1.2.840.113549.1.1.5":    // SHA-1 with RSA Encryption 
305                                                 case "1.3.14.3.2.29":           // SHA1 with RSA signature 
306                                                 case "1.2.840.10040.4.3":       // SHA1-1 with DSA
307                                                         hash = SHA1.Create ();
308                                                         break;
309                                                 default:
310                                                         return null;
311                                         }
312                                         if ((decoder == null) || (decoder.Count < 1))
313                                                 return null;
314                                         byte[] toBeSigned = decoder [0].GetBytes ();
315                                         certhash = hash.ComputeHash (toBeSigned, 0, toBeSigned.Length);
316                                 }
317                                 return (byte[]) certhash.Clone ();
318                         }
319                 }
320
321                 public virtual string IssuerName {
322                         get { return m_issuername; }
323                 }
324
325                 public virtual string KeyAlgorithm {
326                         get { return m_keyalgo; }
327                 }
328
329                 public virtual byte[] KeyAlgorithmParameters {
330                         get {
331                                 if (m_keyalgoparams == null)
332                                         return null;
333                                 return (byte[]) m_keyalgoparams.Clone (); 
334                         }
335                         set { m_keyalgoparams = value; }
336                 }
337
338                 public virtual byte[] PublicKey {
339                         get { 
340                                 if (m_publickey == null)
341                                         return null;
342                                 return (byte[]) m_publickey.Clone ();
343                         }
344                 }
345
346                 public virtual RSA RSA {
347                         get {
348                                 if (_rsa == null) {
349                                         RSAParameters rsaParams = new RSAParameters ();
350                                         // for RSA m_publickey contains 2 ASN.1 integers
351                                         // the modulus and the public exponent
352                                         ASN1 pubkey = new ASN1 (m_publickey);
353                                         ASN1 modulus = pubkey [0];
354                                         if ((modulus == null) || (modulus.Tag != 0x02))
355                                                 return null;
356                                         ASN1 exponent = pubkey [1];
357                                         if (exponent.Tag != 0x02)
358                                                 return null;
359
360                                         rsaParams.Modulus = GetUnsignedBigInteger (modulus.Value);
361                                         rsaParams.Exponent = exponent.Value;
362
363                                         // BUG: MS BCL 1.0 can't import a key which 
364                                         // isn't the same size as the one present in
365                                         // the container.
366                                         int keySize = (rsaParams.Modulus.Length << 3);
367                                         _rsa = (RSA) new RSACryptoServiceProvider (keySize);
368                                         _rsa.ImportParameters (rsaParams);
369                                 }
370                                 return _rsa; 
371                         }
372 #if NET_2_0
373                         set {
374                                 if (value != null)
375                                         _dsa = null;
376                                 _rsa = value;
377                         }
378 #endif
379                 }
380                 
381                 public virtual byte[] RawData {
382                         get {
383                                 if (m_encodedcert == null)
384                                         return null;
385                                 return (byte[]) m_encodedcert.Clone ();
386                         }
387                 }
388
389                 public virtual byte[] SerialNumber {
390                         get { 
391                                 if (serialnumber == null)
392                                         return null;
393                                 return (byte[]) serialnumber.Clone (); 
394                         }
395                 }
396
397                 public virtual byte[] Signature {
398                         get { 
399                                 if (signature == null)
400                                         return null;
401
402                                 switch (m_signaturealgo) {
403                                         case "1.2.840.113549.1.1.2":    // MD2 with RSA encryption 
404                                         case "1.2.840.113549.1.1.4":    // MD5 with RSA encryption 
405                                         case "1.2.840.113549.1.1.5":    // SHA-1 with RSA Encryption 
406                                         case "1.3.14.3.2.29":           // SHA1 with RSA signature
407                                                 return (byte[]) signature.Clone ();
408
409                                         case "1.2.840.10040.4.3":       // SHA-1 with DSA
410                                                 ASN1 sign = new ASN1 (signature);
411                                                 if ((sign == null) || (sign.Count != 2))
412                                                         return null;
413                                                 byte[] part1 = sign [0].Value;
414                                                 byte[] part2 = sign [1].Value;
415                                                 byte[] sig = new byte [40];
416                                                 // parts may be less than 20 bytes (i.e. first bytes were 0x00)
417                                                 // parts may be more than 20 bytes (i.e. first byte > 0x80, negative)
418                                                 int s1 = System.Math.Max (0, part1.Length - 20);
419                                                 int e1 = System.Math.Max (0, 20 - part1.Length);
420                                                 Buffer.BlockCopy (part1, s1, sig, e1, part1.Length - s1);
421                                                 int s2 = System.Math.Max (0, part2.Length - 20);
422                                                 int e2 = System.Math.Max (20, 40 - part2.Length);
423                                                 Buffer.BlockCopy (part2, s2, sig, e2, part2.Length - s2);
424                                                 return sig;
425
426                                         default:
427                                                 throw new CryptographicException ("Unsupported hash algorithm: " + m_signaturealgo);
428                                 }
429                         }
430                 }
431
432                 public virtual string SignatureAlgorithm {
433                         get { return m_signaturealgo; }
434                 }
435
436                 public virtual byte[] SignatureAlgorithmParameters {
437                         get { 
438                                 if (m_signaturealgoparams == null)
439                                         return m_signaturealgoparams;
440                                 return (byte[]) m_signaturealgoparams.Clone ();
441                         }
442                 }
443
444                 public virtual string SubjectName {
445                         get { return m_subject; }
446                 }
447
448                 public virtual DateTime ValidFrom {
449                         get { return m_from; }
450                 }
451
452                 public virtual DateTime ValidUntil {
453                         get { return m_until; }
454                 }
455
456                 public int Version {
457                         get { return version; }
458                 }
459
460                 public bool IsCurrent {
461                         get { return WasCurrent (DateTime.UtcNow); }
462                 }
463
464                 public bool WasCurrent (DateTime instant) 
465                 {
466                         return ((instant > ValidFrom) && (instant <= ValidUntil));
467                 }
468
469                 // uncommon v2 "extension"
470                 public byte[] IssuerUniqueIdentifier {
471                         get {
472                                 if (issuerUniqueID == null)
473                                         return null;
474                                 return (byte[]) issuerUniqueID.Clone ();
475                         }
476                 }
477
478                 // uncommon v2 "extension"
479                 public byte[] SubjectUniqueIdentifier {
480                         get {
481                                 if (subjectUniqueID == null)
482                                         return null;
483                                 return (byte[]) subjectUniqueID.Clone ();
484                         }
485                 }
486
487                 internal bool VerifySignature (DSA dsa) 
488                 {
489                         // signatureOID is check by both this.Hash and this.Signature
490                         DSASignatureDeformatter v = new DSASignatureDeformatter (dsa);
491                         // only SHA-1 is supported
492                         v.SetHashAlgorithm ("SHA1");
493                         return v.VerifySignature (this.Hash, this.Signature);
494                 }
495
496                 internal bool VerifySignature (RSA rsa) 
497                 {
498                         RSAPKCS1SignatureDeformatter v = new RSAPKCS1SignatureDeformatter (rsa);
499                         switch (m_signaturealgo) {
500                                 // MD2 with RSA encryption 
501                                 case "1.2.840.113549.1.1.2":
502                                         // maybe someone installed MD2 ?
503                                         v.SetHashAlgorithm ("MD2");
504                                         break;
505                                 // MD5 with RSA encryption 
506                                 case "1.2.840.113549.1.1.4":
507                                         v.SetHashAlgorithm ("MD5");
508                                         break;
509                                 // SHA-1 with RSA Encryption 
510                                 case "1.2.840.113549.1.1.5":
511                                 case "1.3.14.3.2.29":
512                                         v.SetHashAlgorithm ("SHA1");
513                                         break;
514                                 default:
515                                         throw new CryptographicException ("Unsupported hash algorithm: " + m_signaturealgo);
516                         }
517                         return v.VerifySignature (this.Hash, this.Signature);
518                 }
519
520                 public bool VerifySignature (AsymmetricAlgorithm aa) 
521                 {
522                         if (aa == null)
523                                 throw new ArgumentNullException ("aa");
524
525                         if (aa is RSA)
526                                 return VerifySignature (aa as RSA);
527                         else if (aa is DSA)
528                                 return VerifySignature (aa as DSA);
529                         else 
530                                 throw new NotSupportedException ("Unknown Asymmetric Algorithm " + aa.ToString ());
531                 }
532
533                 public bool CheckSignature (byte[] hash, string hashAlgorithm, byte[] signature) 
534                 {
535                         RSACryptoServiceProvider r = (RSACryptoServiceProvider) RSA;
536                         return r.VerifyHash (hash, hashAlgorithm, signature);
537                 }
538
539                 public bool IsSelfSigned {
540                         get { 
541                                 if (m_issuername == m_subject)
542                                         return VerifySignature (RSA); 
543                                 else
544                                         return false;
545                         }
546                 }
547
548 #if INSIDE_CORLIB || NET_2_0
549                 public ASN1 GetIssuerName ()
550                 {
551                         return issuer;
552                 }
553
554                 public ASN1 GetSubjectName ()
555                 {
556                         return subject;
557                 }
558
559                 protected X509Certificate (SerializationInfo info, StreamingContext context)
560                 {
561                         Parse ((byte[]) info.GetValue ("raw", typeof (byte[])));
562                 }
563
564                 [SecurityPermission (SecurityAction.Demand, SerializationFormatter = true)]
565                 public virtual void GetObjectData (SerializationInfo info, StreamingContext context)
566                 {
567                         info.AddValue ("raw", m_encodedcert);
568                         // note: we NEVER serialize the private key
569                 }
570 #endif
571
572                 static byte[] PEM (string type, byte[] data) 
573                 {
574                         string pem = Encoding.ASCII.GetString (data);
575                         string header = String.Format ("-----BEGIN {0}-----", type);
576                         string footer = String.Format ("-----END {0}-----", type);
577                         int start = pem.IndexOf (header) + header.Length;
578                         int end = pem.IndexOf (footer, start);
579                         string base64 = pem.Substring (start, (end - start));
580                         return Convert.FromBase64String (base64);
581                 }
582         }
583 }