CryptoPkg/Library/BaseCryptLib/Pk/CryptX509.c

   1 /** @file
   2   X.509 Certificate Handler Wrapper Implementation over OpenSSL.
   3
   4 Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "InternalCryptLib.h"
  16 #include <openssl/x509.h>
  17 #include <openssl/rsa.h>
  18
  19 /**
  20   Construct a X509 object from DER-encoded certificate data.
  21
  22   If Cert is NULL, then return FALSE.
  23   If SingleX509Cert is NULL, then return FALSE.
  24
  25   @param[in]  Cert            Pointer to the DER-encoded certificate data.
  26   @param[in]  CertSize        The size of certificate data in bytes.
  27   @param[out] SingleX509Cert  The generated X509 object.
  28
  29   @retval     TRUE            The X509 object generation succeeded.
  30   @retval     FALSE           The operation failed.
  31
  32 **/
  33 BOOLEAN
  34 EFIAPI
  35 X509ConstructCertificate (
  36   IN   CONST UINT8  *Cert,
  37   IN   UINTN        CertSize,
  38   OUT  UINT8        **SingleX509Cert
  39   )
  40 {
  41   X509         *X509Cert;
  42   CONST UINT8  *Temp;
  43
  44   //
  45   // Check input parameters.
  46   //
  47   if (Cert == NULL || SingleX509Cert == NULL || CertSize > INT_MAX) {
  48     return FALSE;
  49   }
  50
  51   //
  52   // Read DER-encoded X509 Certificate and Construct X509 object.
  53   //
  54   Temp     = Cert;
  55   X509Cert = d2i_X509 (NULL, &Temp, (long) CertSize);
  56   if (X509Cert == NULL) {
  57     return FALSE;
  58   }
  59
  60   *SingleX509Cert = (UINT8 *) X509Cert;
  61
  62   return TRUE;
  63 }
  64
  65 /**
  66   Construct a X509 stack object from a list of DER-encoded certificate data.
  67
  68   If X509Stack is NULL, then return FALSE.
  69
  70   @param[in, out]  X509Stack  On input, pointer to an existing or NULL X509 stack object.
  71                               On output, pointer to the X509 stack object with new
  72                               inserted X509 certificate.
  73   @param           ...        A list of DER-encoded single certificate data followed
  74                               by certificate size. A NULL terminates the list. The
  75                               pairs are the arguments to X509ConstructCertificate().
  76
  77   @retval     TRUE            The X509 stack construction succeeded.
  78   @retval     FALSE           The construction operation failed.
  79
  80 **/
  81 BOOLEAN
  82 EFIAPI
  83 X509ConstructCertificateStack (
  84   IN OUT  UINT8  **X509Stack,
  85   ...
  86   )
  87 {
  88   UINT8           *Cert;
  89   UINTN           CertSize;
  90   X509            *X509Cert;
  91   STACK_OF(X509)  *CertStack;
  92   BOOLEAN         Status;
  93   VA_LIST         Args;
  94   UINTN           Index;
  95
  96   //
  97   // Check input parameters.
  98   //
  99   if (X509Stack == NULL) {
 100     return FALSE;
 101   }
 102
 103   Status = FALSE;
 104
 105   //
 106   // Initialize X509 stack object.
 107   //
 108   CertStack = (STACK_OF(X509) *) (*X509Stack);
 109   if (CertStack == NULL) {
 110     CertStack = sk_X509_new_null ();
 111     if (CertStack == NULL) {
 112       return Status;
 113     }
 114   }
 115
 116   VA_START (Args, X509Stack);
 117
 118   for (Index = 0; ; Index++) {
 119     //
 120     // If Cert is NULL, then it is the end of the list.
 121     //
 122     Cert = VA_ARG (Args, UINT8 *);
 123     if (Cert == NULL) {
 124       break;
 125     }
 126
 127     CertSize = VA_ARG (Args, UINTN);
 128     if (CertSize == 0) {
 129       break;
 130     }
 131
 132     //
 133     // Construct X509 Object from the given DER-encoded certificate data.
 134     //
 135     X509Cert = NULL;
 136     Status = X509ConstructCertificate (
 137                (CONST UINT8 *) Cert,
 138                CertSize,
 139                (UINT8 **) &X509Cert
 140                );
 141     if (!Status) {
 142       if (X509Cert != NULL) {
 143         X509_free (X509Cert);
 144       }
 145       break;
 146     }
 147
 148     //
 149     // Insert the new X509 object into X509 stack object.
 150     //
 151     sk_X509_push (CertStack, X509Cert);
 152   }
 153
 154   VA_END (Args);
 155
 156   if (!Status) {
 157     sk_X509_pop_free (CertStack, X509_free);
 158   } else {
 159     *X509Stack = (UINT8 *) CertStack;
 160   }
 161
 162   return Status;
 163 }
 164
 165 /**
 166   Release the specified X509 object.
 167
 168   If X509Cert is NULL, then return FALSE.
 169
 170   @param[in]  X509Cert  Pointer to the X509 object to be released.
 171
 172 **/
 173 VOID
 174 EFIAPI
 175 X509Free (
 176   IN  VOID  *X509Cert
 177   )
 178 {
 179   //
 180   // Check input parameters.
 181   //
 182   if (X509Cert == NULL) {
 183     return;
 184   }
 185
 186   //
 187   // Free OpenSSL X509 object.
 188   //
 189   X509_free ((X509 *) X509Cert);
 190 }
 191
 192 /**
 193   Release the specified X509 stack object.
 194
 195   If X509Stack is NULL, then return FALSE.
 196
 197   @param[in]  X509Stack  Pointer to the X509 stack object to be released.
 198
 199 **/
 200 VOID
 201 EFIAPI
 202 X509StackFree (
 203   IN  VOID  *X509Stack
 204   )
 205 {
 206   //
 207   // Check input parameters.
 208   //
 209   if (X509Stack == NULL) {
 210     return;
 211   }
 212
 213   //
 214   // Free OpenSSL X509 stack object.
 215   //
 216   sk_X509_pop_free ((STACK_OF(X509) *) X509Stack, X509_free);
 217 }
 218
 219 /**
 220   Retrieve the subject bytes from one X.509 certificate.
 221
 222   @param[in]      Cert         Pointer to the DER-encoded X509 certificate.
 223   @param[in]      CertSize     Size of the X509 certificate in bytes.
 224   @param[out]     CertSubject  Pointer to the retrieved certificate subject bytes.
 225   @param[in, out] SubjectSize  The size in bytes of the CertSubject buffer on input,
 226                                and the size of buffer returned CertSubject on output.
 227
 228   If Cert is NULL, then return FALSE.
 229   If SubjectSize is NULL, then return FALSE.
 230
 231   @retval  TRUE   The certificate subject retrieved successfully.
 232   @retval  FALSE  Invalid certificate, or the SubjectSize is too small for the result.
 233                   The SubjectSize will be updated with the required size.
 234
 235 **/
 236 BOOLEAN
 237 EFIAPI
 238 X509GetSubjectName (
 239   IN      CONST UINT8  *Cert,
 240   IN      UINTN        CertSize,
 241   OUT     UINT8        *CertSubject,
 242   IN OUT  UINTN        *SubjectSize
 243   )
 244 {
 245   BOOLEAN    Status;
 246   X509       *X509Cert;
 247   X509_NAME  *X509Name;
 248   UINTN      X509NameSize;
 249
 250   //
 251   // Check input parameters.
 252   //
 253   if (Cert == NULL || SubjectSize == NULL) {
 254     return FALSE;
 255   }
 256
 257   X509Cert = NULL;
 258
 259   //
 260   // Read DER-encoded X509 Certificate and Construct X509 object.
 261   //
 262   Status = X509ConstructCertificate (Cert, CertSize, (UINT8 **) &X509Cert);
 263   if ((X509Cert == NULL) || (!Status)) {
 264     Status = FALSE;
 265     goto _Exit;
 266   }
 267
 268   Status = FALSE;
 269
 270   //
 271   // Retrieve subject name from certificate object.
 272   //
 273   X509Name = X509_get_subject_name (X509Cert);
 274   if (X509Name == NULL) {
 275     goto _Exit;
 276   }
 277
 278   X509NameSize = i2d_X509_NAME(X509Name, NULL);
 279   if (*SubjectSize < X509NameSize) {
 280     *SubjectSize = X509NameSize;
 281     goto _Exit;
 282   }
 283   *SubjectSize = X509NameSize;
 284   if (CertSubject != NULL) {
 285     i2d_X509_NAME(X509Name, &CertSubject);
 286     Status = TRUE;
 287   }
 288
 289 _Exit:
 290   //
 291   // Release Resources.
 292   //
 293   if (X509Cert != NULL) {
 294     X509_free (X509Cert);
 295   }
 296
 297   return Status;
 298 }
 299
 300 /**
 301   Retrieve the common name (CN) string from one X.509 certificate.
 302
 303   @param[in]      Cert             Pointer to the DER-encoded X509 certificate.
 304   @param[in]      CertSize         Size of the X509 certificate in bytes.
 305   @param[out]     CommonName       Buffer to contain the retrieved certificate common
 306                                    name string. At most CommonNameSize bytes will be
 307                                    written and the string will be null terminated. May be
 308                                    NULL in order to determine the size buffer needed.
 309   @param[in,out]  CommonNameSize   The size in bytes of the CommonName buffer on input,
 310                                    and the size of buffer returned CommonName on output.
 311                                    If CommonName is NULL then the amount of space needed
 312                                    in buffer (including the final null) is returned.
 313
 314   @retval RETURN_SUCCESS           The certificate CommonName retrieved successfully.
 315   @retval RETURN_INVALID_PARAMETER If Cert is NULL.
 316                                    If CommonNameSize is NULL.
 317                                    If CommonName is not NULL and *CommonNameSize is 0.
 318                                    If Certificate is invalid.
 319   @retval RETURN_NOT_FOUND         If no CommonName entry exists.
 320   @retval RETURN_BUFFER_TOO_SMALL  If the CommonName is NULL. The required buffer size
 321                                    (including the final null) is returned in the
 322                                    CommonNameSize parameter.
 323   @retval RETURN_UNSUPPORTED       The operation is not supported.
 324
 325 **/
 326 RETURN_STATUS
 327 EFIAPI
 328 X509GetCommonName (
 329   IN      CONST UINT8  *Cert,
 330   IN      UINTN        CertSize,
 331   OUT     CHAR8        *CommonName,  OPTIONAL
 332   IN OUT  UINTN        *CommonNameSize
 333   )
 334 {
 335   RETURN_STATUS  ReturnStatus;
 336   BOOLEAN        Status;
 337   X509           *X509Cert;
 338   X509_NAME      *X509Name;
 339   INTN           Length;
 340
 341   ReturnStatus = RETURN_INVALID_PARAMETER;
 342
 343   //
 344   // Check input parameters.
 345   //
 346   if ((Cert == NULL) || (CertSize > INT_MAX) || (CommonNameSize == NULL)) {
 347     return ReturnStatus;
 348   }
 349   if ((CommonName != NULL) && (*CommonNameSize == 0)) {
 350     return ReturnStatus;
 351   }
 352
 353   X509Cert = NULL;
 354   //
 355   // Read DER-encoded X509 Certificate and Construct X509 object.
 356   //
 357   Status = X509ConstructCertificate (Cert, CertSize, (UINT8 **) &X509Cert);
 358   if ((X509Cert == NULL) || (!Status)) {
 359     //
 360     // Invalid X.509 Certificate
 361     //
 362     goto _Exit;
 363   }
 364
 365   Status = FALSE;
 366
 367   //
 368   // Retrieve subject name from certificate object.
 369   //
 370   X509Name = X509_get_subject_name (X509Cert);
 371   if (X509Name == NULL) {
 372     //
 373     // Fail to retrieve subject name content
 374     //
 375     goto _Exit;
 376   }
 377
 378   //
 379   // Retrieve the CommonName information from X.509 Subject
 380   //
 381   Length = (INTN) X509_NAME_get_text_by_NID (X509Name, NID_commonName, CommonName, (int)(*CommonNameSize));
 382   if (Length < 0) {
 383     //
 384     // No CommonName entry exists in X509_NAME object
 385     //
 386     *CommonNameSize = 0;
 387     ReturnStatus    = RETURN_NOT_FOUND;
 388     goto _Exit;
 389   }
 390
 391   *CommonNameSize = (UINTN)(Length + 1);
 392   if (CommonName == NULL) {
 393     ReturnStatus = RETURN_BUFFER_TOO_SMALL;
 394   } else {
 395     ReturnStatus = RETURN_SUCCESS;
 396   }
 397
 398 _Exit:
 399   //
 400   // Release Resources.
 401   //
 402   if (X509Cert != NULL) {
 403     X509_free (X509Cert);
 404   }
 405
 406   return ReturnStatus;
 407 }
 408
 409 /**
 410   Retrieve the RSA Public Key from one DER-encoded X509 certificate.
 411
 412   @param[in]  Cert         Pointer to the DER-encoded X509 certificate.
 413   @param[in]  CertSize     Size of the X509 certificate in bytes.
 414   @param[out] RsaContext   Pointer to new-generated RSA context which contain the retrieved
 415                            RSA public key component. Use RsaFree() function to free the
 416                            resource.
 417
 418   If Cert is NULL, then return FALSE.
 419   If RsaContext is NULL, then return FALSE.
 420
 421   @retval  TRUE   RSA Public Key was retrieved successfully.
 422   @retval  FALSE  Fail to retrieve RSA public key from X509 certificate.
 423
 424 **/
 425 BOOLEAN
 426 EFIAPI
 427 RsaGetPublicKeyFromX509 (
 428   IN   CONST UINT8  *Cert,
 429   IN   UINTN        CertSize,
 430   OUT  VOID         **RsaContext
 431   )
 432 {
 433   BOOLEAN   Status;
 434   EVP_PKEY  *Pkey;
 435   X509      *X509Cert;
 436
 437   //
 438   // Check input parameters.
 439   //
 440   if (Cert == NULL || RsaContext == NULL) {
 441     return FALSE;
 442   }
 443
 444   Pkey     = NULL;
 445   X509Cert = NULL;
 446
 447   //
 448   // Read DER-encoded X509 Certificate and Construct X509 object.
 449   //
 450   Status = X509ConstructCertificate (Cert, CertSize, (UINT8 **) &X509Cert);
 451   if ((X509Cert == NULL) || (!Status)) {
 452     Status = FALSE;
 453     goto _Exit;
 454   }
 455
 456   Status = FALSE;
 457
 458   //
 459   // Retrieve and check EVP_PKEY data from X509 Certificate.
 460   //
 461   Pkey = X509_get_pubkey (X509Cert);
 462   if ((Pkey == NULL) || (EVP_PKEY_id (Pkey) != EVP_PKEY_RSA)) {
 463     goto _Exit;
 464   }
 465
 466   //
 467   // Duplicate RSA Context from the retrieved EVP_PKEY.
 468   //
 469   if ((*RsaContext = RSAPublicKey_dup (EVP_PKEY_get0_RSA (Pkey))) != NULL) {
 470     Status = TRUE;
 471   }
 472
 473 _Exit:
 474   //
 475   // Release Resources.
 476   //
 477   if (X509Cert != NULL) {
 478     X509_free (X509Cert);
 479   }
 480
 481   if (Pkey != NULL) {
 482     EVP_PKEY_free (Pkey);
 483   }
 484
 485   return Status;
 486 }
 487
 488 /**
 489   Verify one X509 certificate was issued by the trusted CA.
 490
 491   @param[in]      Cert         Pointer to the DER-encoded X509 certificate to be verified.
 492   @param[in]      CertSize     Size of the X509 certificate in bytes.
 493   @param[in]      CACert       Pointer to the DER-encoded trusted CA certificate.
 494   @param[in]      CACertSize   Size of the CA Certificate in bytes.
 495
 496   If Cert is NULL, then return FALSE.
 497   If CACert is NULL, then return FALSE.
 498
 499   @retval  TRUE   The certificate was issued by the trusted CA.
 500   @retval  FALSE  Invalid certificate or the certificate was not issued by the given
 501                   trusted CA.
 502
 503 **/
 504 BOOLEAN
 505 EFIAPI
 506 X509VerifyCert (
 507   IN  CONST UINT8  *Cert,
 508   IN  UINTN        CertSize,
 509   IN  CONST UINT8  *CACert,
 510   IN  UINTN        CACertSize
 511   )
 512 {
 513   BOOLEAN         Status;
 514   X509            *X509Cert;
 515   X509            *X509CACert;
 516   X509_STORE      *CertStore;
 517   X509_STORE_CTX  *CertCtx;
 518
 519   //
 520   // Check input parameters.
 521   //
 522   if (Cert == NULL || CACert == NULL) {
 523     return FALSE;
 524   }
 525
 526   Status     = FALSE;
 527   X509Cert   = NULL;
 528   X509CACert = NULL;
 529   CertStore  = NULL;
 530   CertCtx    = NULL;
 531
 532   //
 533   // Register & Initialize necessary digest algorithms for certificate verification.
 534   //
 535   if (EVP_add_digest (EVP_md5 ()) == 0) {
 536     goto _Exit;
 537   }
 538   if (EVP_add_digest (EVP_sha1 ()) == 0) {
 539     goto _Exit;
 540   }
 541   if (EVP_add_digest (EVP_sha256 ()) == 0) {
 542     goto _Exit;
 543   }
 544
 545   //
 546   // Read DER-encoded certificate to be verified and Construct X509 object.
 547   //
 548   Status = X509ConstructCertificate (Cert, CertSize, (UINT8 **) &X509Cert);
 549   if ((X509Cert == NULL) || (!Status)) {
 550     Status = FALSE;
 551     goto _Exit;
 552   }
 553
 554   //
 555   // Read DER-encoded root certificate and Construct X509 object.
 556   //
 557   Status = X509ConstructCertificate (CACert, CACertSize, (UINT8 **) &X509CACert);
 558   if ((X509CACert == NULL) || (!Status)) {
 559     Status = FALSE;
 560     goto _Exit;
 561   }
 562
 563   Status = FALSE;
 564
 565   //
 566   // Set up X509 Store for trusted certificate.
 567   //
 568   CertStore = X509_STORE_new ();
 569   if (CertStore == NULL) {
 570     goto _Exit;
 571   }
 572   if (!(X509_STORE_add_cert (CertStore, X509CACert))) {
 573     goto _Exit;
 574   }
 575
 576   //
 577   // Allow partial certificate chains, terminated by a non-self-signed but
 578   // still trusted intermediate certificate. Also disable time checks.
 579   //
 580   X509_STORE_set_flags (CertStore,
 581                         X509_V_FLAG_PARTIAL_CHAIN | X509_V_FLAG_NO_CHECK_TIME);
 582
 583   //
 584   // Set up X509_STORE_CTX for the subsequent verification operation.
 585   //
 586   CertCtx = X509_STORE_CTX_new ();
 587   if (CertCtx == NULL) {
 588     goto _Exit;
 589   }
 590   if (!X509_STORE_CTX_init (CertCtx, CertStore, X509Cert, NULL)) {
 591     goto _Exit;
 592   }
 593
 594   //
 595   // X509 Certificate Verification.
 596   //
 597   Status = (BOOLEAN) X509_verify_cert (CertCtx);
 598   X509_STORE_CTX_cleanup (CertCtx);
 599
 600 _Exit:
 601   //
 602   // Release Resources.
 603   //
 604   if (X509Cert != NULL) {
 605     X509_free (X509Cert);
 606   }
 607
 608   if (X509CACert != NULL) {
 609     X509_free (X509CACert);
 610   }
 611
 612   if (CertStore != NULL) {
 613     X509_STORE_free (CertStore);
 614   }
 615
 616   X509_STORE_CTX_free (CertCtx);
 617
 618   return Status;
 619 }
 620
 621 /**
 622   Retrieve the TBSCertificate from one given X.509 certificate.
 623
 624   @param[in]      Cert         Pointer to the given DER-encoded X509 certificate.
 625   @param[in]      CertSize     Size of the X509 certificate in bytes.
 626   @param[out]     TBSCert      DER-Encoded To-Be-Signed certificate.
 627   @param[out]     TBSCertSize  Size of the TBS certificate in bytes.
 628
 629   If Cert is NULL, then return FALSE.
 630   If TBSCert is NULL, then return FALSE.
 631   If TBSCertSize is NULL, then return FALSE.
 632
 633   @retval  TRUE   The TBSCertificate was retrieved successfully.
 634   @retval  FALSE  Invalid X.509 certificate.
 635
 636 **/
 637 BOOLEAN
 638 EFIAPI
 639 X509GetTBSCert (
 640   IN  CONST UINT8  *Cert,
 641   IN  UINTN        CertSize,
 642   OUT UINT8        **TBSCert,
 643   OUT UINTN        *TBSCertSize
 644   )
 645 {
 646   CONST UINT8  *Temp;
 647   INTN         Asn1Tag;
 648   INTN         ObjClass;
 649   UINTN        Length;
 650
 651   //
 652   // Check input parameters.
 653   //
 654   if ((Cert == NULL) || (TBSCert == NULL) ||
 655       (TBSCertSize == NULL) || (CertSize > INT_MAX)) {
 656     return FALSE;
 657   }
 658
 659   //
 660   // An X.509 Certificate is: (defined in RFC3280)
 661   //   Certificate  ::=  SEQUENCE  {
 662   //     tbsCertificate       TBSCertificate,
 663   //     signatureAlgorithm   AlgorithmIdentifier,
 664   //     signature            BIT STRING }
 665   //
 666   // and
 667   //
 668   //  TBSCertificate  ::=  SEQUENCE  {
 669   //    version         [0]  Version DEFAULT v1,
 670   //    ...
 671   //    }
 672   //
 673   // So we can just ASN1-parse the x.509 DER-encoded data. If we strip
 674   // the first SEQUENCE, the second SEQUENCE is the TBSCertificate.
 675   //
 676   Temp = Cert;
 677   ASN1_get_object (&Temp, (long *)&Length, (int *)&Asn1Tag, (int *)&ObjClass, (long)CertSize);
 678
 679   if (Asn1Tag != V_ASN1_SEQUENCE) {
 680     return FALSE;
 681   }
 682
 683   *TBSCert = (UINT8 *)Temp;
 684
 685   ASN1_get_object (&Temp, (long *)&Length, (int *)&Asn1Tag, (int *)&ObjClass, (long)Length);
 686   //
 687   // Verify the parsed TBSCertificate is one correct SEQUENCE data.
 688   //
 689   if (Asn1Tag != V_ASN1_SEQUENCE) {
 690     return FALSE;
 691   }
 692
 693   *TBSCertSize = Length + (Temp - *TBSCert);
 694
 695   return TRUE;
 696 }