Update return FALSE to ASSERT() for code consistent.

[mirror_edk2.git] / CryptoPkg / Library / BaseCryptLib / Pk / CryptPkcs7.c

/** @file\r
  PKCS#7 SignedData Verification Wrapper Implementation over OpenSSL.\r
\r
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "InternalCryptLib.h"\r
\r
#include <openssl/objects.h>\r
#include <openssl/x509.h>\r
#include <openssl/pkcs7.h>\r
\r
UINT8 mOidValue[9] = { 0x2A, 0x86, 0x48, 0x86, 0xF7, 0x0D, 0x01, 0x07, 0x02 };\r
\r
/**\r
  Verification callback function to override any existing callbacks in OpenSSL\r
  for intermediate certificate supports.\r
\r
  @param[in]  Status   Original status before calling this callback.\r
  @param[in]  Context  X509 store context.\r
\r
  @retval     1        Current X509 certificate is verified successfully.\r
  @retval     0        Verification failed.\r
\r
**/\r
int\r
X509VerifyCb (\r
  IN int            Status,\r
  IN X509_STORE_CTX *Context\r
  )\r
{\r
  X509_OBJECT  *Obj;\r
  INTN         Error;\r
  INTN         Index;\r
  INTN         Count;\r
\r
  Obj   = NULL;\r
  Error = (INTN) X509_STORE_CTX_get_error (Context);\r
\r
  //\r
  // X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT and X509_V_ERR_UNABLE_TO_GET_ISSUER_\r
  // CERT_LOCALLY mean a X509 certificate is not self signed and its issuer\r
  // can not be found in X509_verify_cert of X509_vfy.c.\r
  // In order to support intermediate certificate node, we override the\r
  // errors if the certification is obtained from X509 store, i.e. it is\r
  // a trusted ceritifcate node that is enrolled by user.\r
  // Besides,X509_V_ERR_CERT_UNTRUSTED and X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE\r
  // are also ignored to enable such feature.\r
  //\r
  if ((Error == X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT) ||\r
      (Error == X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY)) {\r
    Obj = (X509_OBJECT *) OPENSSL_malloc (sizeof (X509_OBJECT));\r
    if (Obj == NULL) {\r
      return 0;\r
    }\r
\r
    Obj->type      = X509_LU_X509;\r
    Obj->data.x509 = Context->current_cert;\r
\r
    CRYPTO_w_lock (CRYPTO_LOCK_X509_STORE);\r
\r
    if (X509_OBJECT_retrieve_match (Context->ctx->objs, Obj)) {\r
      Status = 1;\r
    } else {\r
      //\r
      // If any certificate in the chain is enrolled as trusted certificate,\r
      // pass the certificate verification.\r
      //\r
      if (Error == X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY) {\r
        Count = (INTN) sk_X509_num (Context->chain);\r
        for (Index = 0; Index < Count; Index++) {\r
          Obj->data.x509 = sk_X509_value (Context->chain, (int) Index);\r
          if (X509_OBJECT_retrieve_match (Context->ctx->objs, Obj)) {\r
            Status = 1;\r
            break;\r
          }\r
        }\r
      }\r
    }\r
\r
    CRYPTO_w_unlock (CRYPTO_LOCK_X509_STORE);\r
  }\r
\r
  if ((Error == X509_V_ERR_CERT_UNTRUSTED) ||\r
      (Error == X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE)) {\r
    Status = 1;\r
  }\r
\r
  if (Obj != NULL) {\r
    OPENSSL_free (Obj);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Creates a PKCS#7 signedData as described in "PKCS #7: Cryptographic Message\r
  Syntax Standard, version 1.5". This interface is only intended to be used for\r
  application to perform PKCS#7 functionality validation.\r
\r
  @param[in]  PrivateKey       Pointer to the PEM-formatted private key data for\r
                               data signing.\r
  @param[in]  PrivateKeySize   Size of the PEM private key data in bytes.\r
  @param[in]  KeyPassword      NULL-terminated passphrase used for encrypted PEM\r
                               key data.\r
  @param[in]  InData           Pointer to the content to be signed.\r
  @param[in]  InDataSize       Size of InData in bytes.\r
  @param[in]  SignCert         Pointer to signer's DER-encoded certificate to sign with.\r
  @param[in]  OtherCerts       Pointer to an optional additional set of certificates to\r
                               include in the PKCS#7 signedData (e.g. any intermediate\r
                               CAs in the chain).\r
  @param[out] SignedData       Pointer to output PKCS#7 signedData.\r
  @param[out] SignedDataSize   Size of SignedData in bytes.\r
\r
  @retval     TRUE             PKCS#7 data signing succeeded.\r
  @retval     FALSE            PKCS#7 data signing failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Pkcs7Sign (\r
  IN   CONST UINT8  *PrivateKey,\r
  IN   UINTN        PrivateKeySize,\r
  IN   CONST UINT8  *KeyPassword,\r
  IN   UINT8        *InData,\r
  IN   UINTN        InDataSize,\r
  IN   UINT8        *SignCert,\r
  IN   UINT8        *OtherCerts      OPTIONAL,\r
  OUT  UINT8        **SignedData,\r
  OUT  UINTN        *SignedDataSize\r
  )\r
{\r
  BOOLEAN   Status;\r
  EVP_PKEY  *Key;\r
  BIO       *DataBio;\r
  PKCS7     *Pkcs7;\r
  UINT8     *RsaContext;\r
  UINT8     *P7Data;\r
  UINTN     P7DataSize;\r
  UINT8     *Tmp;\r
\r
  //\r
  // Check input parameters.\r
  //\r
  ASSERT (PrivateKey     != NULL);\r
  ASSERT (KeyPassword    != NULL);\r
  ASSERT (InData         != NULL);\r
  ASSERT (SignCert       != NULL);\r
  ASSERT (SignedData     != NULL);\r
  ASSERT (SignedDataSize != NULL);\r
  ASSERT (InDataSize     <= INT_MAX);\r
\r
  RsaContext = NULL;\r
  Key        = NULL;\r
  Pkcs7      = NULL;\r
  DataBio    = NULL;\r
  Status     = FALSE;\r
\r
  //\r
  // Retrieve RSA private key from PEM data.\r
  //\r
  Status = RsaGetPrivateKeyFromPem (\r
             PrivateKey,\r
             PrivateKeySize,\r
             (CONST CHAR8 *) KeyPassword,\r
             (VOID **) &RsaContext\r
             );\r
  if (!Status) {\r
    return Status;\r
  }\r
\r
  //\r
  // Register & Initialize necessary digest algorithms and PRNG for PKCS#7 Handling\r
  //\r
  EVP_add_digest (EVP_md5());\r
  EVP_add_digest (EVP_sha1());\r
  EVP_add_digest (EVP_sha256());\r
  RandomSeed (NULL, 0);\r
\r
  //\r
  // Construct OpenSSL EVP_PKEY for private key.\r
  //\r
  Key = EVP_PKEY_new ();\r
  if (Key == NULL) {\r
    goto _Exit;\r
  }\r
  Key->save_type = EVP_PKEY_RSA;\r
  Key->type      = EVP_PKEY_type (EVP_PKEY_RSA);\r
  Key->pkey.rsa  = (RSA *) RsaContext;\r
\r
  //\r
  // Convert the data to be signed to BIO format. \r
  //\r
  DataBio = BIO_new (BIO_s_mem ());\r
  BIO_write (DataBio, InData, (int) InDataSize);\r
\r
  //\r
  // Create the PKCS#7 signedData structure.\r
  //\r
  Pkcs7 = PKCS7_sign (\r
            (X509 *) SignCert,\r
            Key,\r
            (STACK_OF(X509) *) OtherCerts,\r
            DataBio,\r
            PKCS7_BINARY | PKCS7_NOATTR | PKCS7_DETACHED\r
            );\r
  if (Pkcs7 == NULL) {\r
    goto _Exit;\r
  }\r
\r
  //\r
  // Convert PKCS#7 signedData structure into DER-encoded buffer.\r
  //\r
  P7DataSize = i2d_PKCS7 (Pkcs7, NULL);\r
  if (P7DataSize <= 19) {\r
    goto _Exit;\r
  }\r
  P7Data     = OPENSSL_malloc (P7DataSize);\r
  Tmp        = P7Data;\r
  P7DataSize = i2d_PKCS7 (Pkcs7, (unsigned char **) &Tmp);\r
\r
  //\r
  // Strip ContentInfo to content only for signeddata. The data be trimmed off\r
  // is totally 19 bytes.\r
  //\r
  *SignedDataSize = P7DataSize - 19;\r
  *SignedData     = OPENSSL_malloc (*SignedDataSize);\r
  CopyMem (*SignedData, P7Data + 19, *SignedDataSize);\r
  \r
  OPENSSL_free (P7Data);\r
\r
  Status = TRUE;\r
\r
_Exit:\r
  //\r
  // Release Resources\r
  //\r
  if (RsaContext != NULL) {\r
    RsaFree (RsaContext);\r
    if (Key != NULL) {\r
      Key->pkey.rsa = NULL;\r
    }\r
  }\r
\r
  if (Key != NULL) {\r
    EVP_PKEY_free (Key);\r
  }\r
\r
  if (DataBio != NULL) {\r
    BIO_free (DataBio);\r
  }\r
\r
  if (Pkcs7 != NULL) {\r
    PKCS7_free (Pkcs7);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Verifies the validility of a PKCS#7 signed data as described in "PKCS #7:\r
  Cryptographic Message Syntax Standard". The input signed data could be wrapped\r
  in a ContentInfo structure.\r
\r
  If P7Data is NULL, then ASSERT().\r
\r
  @param[in]  P7Data       Pointer to the PKCS#7 message to verify.\r
  @param[in]  P7Length     Length of the PKCS#7 message in bytes.\r
  @param[in]  TrustedCert  Pointer to a trusted/root certificate encoded in DER, which\r
                           is used for certificate chain verification.\r
  @param[in]  CertLength   Length of the trusted certificate in bytes.\r
  @param[in]  InData       Pointer to the content to be verified.\r
  @param[in]  DataLength   Length of InData in bytes.\r
\r
  @retval  TRUE  The specified PKCS#7 signed data is valid.\r
  @retval  FALSE Invalid PKCS#7 signed data.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Pkcs7Verify (\r
  IN  CONST UINT8  *P7Data,\r
  IN  UINTN        P7Length,\r
  IN  CONST UINT8  *TrustedCert,\r
  IN  UINTN        CertLength,\r
  IN  CONST UINT8  *InData,\r
  IN  UINTN        DataLength\r
  )\r
{\r
  PKCS7       *Pkcs7;\r
  BIO         *CertBio;\r
  BIO         *DataBio;\r
  BOOLEAN     Status;\r
  X509        *Cert;\r
  X509_STORE  *CertStore;\r
  UINT8       *SignedData;\r
  UINT8       *Temp;\r
  UINTN       SignedDataSize;\r
  BOOLEAN     Wrapped;\r
\r
  //\r
  // ASSERT if any input parameter is invalid.\r
  //\r
  ASSERT (P7Data      != NULL);\r
  ASSERT (TrustedCert != NULL);\r
  ASSERT (InData      != NULL);\r
  ASSERT (P7Length    <= INT_MAX);\r
  ASSERT (CertLength  <= INT_MAX);\r
  ASSERT (DataLength  <= INT_MAX);\r
\r
  Status    = FALSE;\r
  Pkcs7     = NULL;\r
  CertBio   = NULL;\r
  DataBio   = NULL;\r
  Cert      = NULL;\r
  CertStore = NULL;\r
\r
  //\r
  // Register & Initialize necessary digest algorithms for PKCS#7 Handling\r
  //\r
  EVP_add_digest (EVP_md5());\r
  EVP_add_digest (EVP_sha1());\r
  EVP_add_digest_alias (SN_sha1WithRSAEncryption, SN_sha1WithRSA);\r
  EVP_add_digest (EVP_sha256());\r
\r
  //\r
  // Check whether input P7Data is a wrapped ContentInfo structure or not.\r
  //\r
  Wrapped = FALSE;\r
  if ((P7Data[4] == 0x06) && (P7Data[5] == 0x09)) {\r
    if (CompareMem (P7Data + 6, mOidValue, sizeof (mOidValue)) == 0) {\r
      if ((P7Data[15] == 0xA0) && (P7Data[16] == 0x82)) {\r
        Wrapped = TRUE;\r
      }\r
    }\r
  }\r
\r
  if (Wrapped) {\r
    SignedData     = (UINT8 *) P7Data;\r
    SignedDataSize = P7Length;\r
  } else {\r
    //\r
    // Wrap PKCS#7 signeddata to a ContentInfo structure - add a header in 19 bytes.\r
    //\r
    SignedDataSize = P7Length + 19;\r
    SignedData     = OPENSSL_malloc (SignedDataSize);\r
    if (SignedData == NULL) {\r
      return FALSE;\r
    }\r
\r
    //\r
    // Part1: 0x30, 0x82.\r
    //\r
    SignedData[0] = 0x30;\r
    SignedData[1] = 0x82;\r
\r
    //\r
    // Part2: Length1 = P7Length + 19 - 4, in big endian.\r
    //\r
    SignedData[2] = (UINT8) (((UINT16) (SignedDataSize - 4)) >> 8);\r
    SignedData[3] = (UINT8) (((UINT16) (SignedDataSize - 4)) & 0xff);\r
\r
    //\r
    // Part3: 0x06, 0x09.\r
    //\r
    SignedData[4] = 0x06;\r
    SignedData[5] = 0x09;\r
\r
    //\r
    // Part4: OID value -- 0x2A 0x86 0x48 0x86 0xF7 0x0D 0x01 0x07 0x02.\r
    //\r
    CopyMem (SignedData + 6, mOidValue, sizeof (mOidValue));\r
\r
    //\r
    // Part5: 0xA0, 0x82.\r
    //\r
    SignedData[15] = 0xA0;\r
    SignedData[16] = 0x82;\r
\r
    //\r
    // Part6: Length2 = P7Length, in big endian.\r
    //\r
    SignedData[17] = (UINT8) (((UINT16) P7Length) >> 8);\r
    SignedData[18] = (UINT8) (((UINT16) P7Length) & 0xff);\r
\r
    //\r
    // Part7: P7Data.\r
    //\r
    CopyMem (SignedData + 19, P7Data, P7Length);\r
  }\r
  \r
  //\r
  // Retrieve PKCS#7 Data (DER encoding)\r
  //\r
  if (SignedDataSize > INT_MAX) {\r
    goto _Exit;\r
  }\r
\r
  Temp = SignedData;\r
  Pkcs7 = d2i_PKCS7 (NULL, (const unsigned char **) &Temp, (int) SignedDataSize);\r
  if (Pkcs7 == NULL) {\r
    goto _Exit;\r
  }\r
\r
  //\r
  // Check if it's PKCS#7 Signed Data (for Authenticode Scenario)\r
  //\r
  if (!PKCS7_type_is_signed (Pkcs7)) {\r
    goto _Exit;\r
  }\r
\r
  //\r
  // Read DER-encoded root certificate and Construct X509 Certificate\r
  //\r
  CertBio = BIO_new (BIO_s_mem ());\r
  BIO_write (CertBio, TrustedCert, (int)CertLength);\r
  if (CertBio == NULL) {\r
    goto _Exit;\r
  }\r
  Cert = d2i_X509_bio (CertBio, NULL);\r
  if (Cert == NULL) {\r
    goto _Exit;\r
  }\r
\r
  //\r
  // Setup X509 Store for trusted certificate\r
  //\r
  CertStore = X509_STORE_new ();\r
  if (CertStore == NULL) {\r
    goto _Exit;\r
  }\r
  if (!(X509_STORE_add_cert (CertStore, Cert))) {\r
    goto _Exit;\r
  }\r
\r
  //\r
  // Register customized X509 verification callback function to support\r
  // trusted intermediate certificate anchor.\r
  //\r
  CertStore->verify_cb = X509VerifyCb;\r
\r
  //\r
  // For generic PKCS#7 handling, InData may be NULL if the content is present\r
  // in PKCS#7 structure. So ignore NULL checking here.\r
  //\r
  DataBio = BIO_new (BIO_s_mem ());\r
  BIO_write (DataBio, InData, (int)DataLength);\r
\r
  //\r
  // Verifies the PKCS#7 signedData structure\r
  //\r
  Status = (BOOLEAN) PKCS7_verify (Pkcs7, NULL, CertStore, DataBio, NULL, PKCS7_BINARY);\r
\r
_Exit:\r
  //\r
  // Release Resources\r
  //\r
  BIO_free (DataBio);\r
  BIO_free (CertBio);\r
  X509_free (Cert);\r
  X509_STORE_free (CertStore);\r
  PKCS7_free (Pkcs7);\r
\r
  if (!Wrapped) {\r
    OPENSSL_free (SignedData);\r
  }\r
\r
  return Status;\r
}\r