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

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