[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 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
    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
	70	@param[in, out] X509Stack On input, pointer to an existing X509 stack object.\r
	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
	135	Status = X509ConstructCertificate (\r
	136	(CONST UINT8 *) Cert,\r
	137	CertSize,\r
	138	(UINT8 **) &X509Cert\r
	139	);\r
	140	if (!Status) {\r
1463ce18 QL	141	if (X509Cert != NULL) {\r
	142	X509_free (X509Cert);\r
	143	}\r
b7d320f8	144	break;\r
	145	}\r
	146	\r
	147	//\r
	148	// Insert the new X509 object into X509 stack object.\r
	149	//\r
	150	sk_X509_push (CertStack, X509Cert);\r
	151	}\r
	152	\r
	153	VA_END (Args);\r
	154	\r
	155	if (!Status) {\r
	156	sk_X509_pop_free (CertStack, X509_free);\r
	157	} else {\r
	158	X509Stack = (UINT8 ) CertStack;\r
	159	}\r
	160	\r
	161	return Status;\r
	162	}\r
	163	\r
	164	/**\r
	165	Release the specified X509 object.\r
	166	\r
16d2c32c	167	If X509Cert is NULL, then return FALSE.\r
b7d320f8	168	\r
	169	@param[in] X509Cert Pointer to the X509 object to be released.\r
	170	\r
	171	**/\r
	172	VOID\r
	173	EFIAPI\r
	174	X509Free (\r
	175	IN VOID *X509Cert\r
	176	)\r
16d2c32c	177	{ \r
	178	//\r
	179	// Check input parameters.\r
	180	//\r
	181	if (X509Cert == NULL) {\r
	182	return;\r
	183	}\r
	184	\r
b7d320f8	185	//\r
	186	// Free OpenSSL X509 object.\r
	187	//\r
	188	X509_free ((X509 *) X509Cert);\r
	189	}\r
	190	\r
	191	/**\r
	192	Release the specified X509 stack object.\r
	193	\r
16d2c32c	194	If X509Stack is NULL, then return FALSE.\r
b7d320f8	195	\r
	196	@param[in] X509Stack Pointer to the X509 stack object to be released.\r
	197	\r
	198	**/\r
	199	VOID\r
	200	EFIAPI\r
	201	X509StackFree (\r
	202	IN VOID *X509Stack\r
	203	)\r
	204	{\r
16d2c32c	205	//\r
	206	// Check input parameters.\r
	207	//\r
	208	if (X509Stack == NULL) {\r
	209	return;\r
	210	}\r
	211	\r
b7d320f8	212	//\r
	213	// Free OpenSSL X509 stack object.\r
	214	//\r
	215	sk_X509_pop_free ((STACK_OF(X509) *) X509Stack, X509_free);\r
	216	}\r
	217	\r
4a567c96	218	/**\r
	219	Retrieve the subject bytes from one X.509 certificate.\r
	220	\r
	221	@param[in] Cert Pointer to the DER-encoded X509 certificate.\r
	222	@param[in] CertSize Size of the X509 certificate in bytes.\r
	223	@param[out] CertSubject Pointer to the retrieved certificate subject bytes.\r
	224	@param[in, out] SubjectSize The size in bytes of the CertSubject buffer on input,\r
	225	and the size of buffer returned CertSubject on output.\r
	226	\r
16d2c32c	227	If Cert is NULL, then return FALSE.\r
16d2c32c	228	If SubjectSize is NULL, then return FALSE.\r
4a567c96	229	\r
	230	@retval TRUE The certificate subject retrieved successfully.\r
	231	@retval FALSE Invalid certificate, or the SubjectSize is too small for the result.\r
	232	The SubjectSize will be updated with the required size.\r
	233	\r
	234	**/\r
	235	BOOLEAN\r
	236	EFIAPI\r
	237	X509GetSubjectName (\r
	238	IN CONST UINT8 *Cert,\r
	239	IN UINTN CertSize,\r
	240	OUT UINT8 *CertSubject,\r
	241	IN OUT UINTN *SubjectSize\r
	242	)\r
	243	{\r
	244	BOOLEAN Status;\r
4a567c96	245	X509 *X509Cert;\r
	246	X509_NAME *X509Name;\r
	247	\r
	248	//\r
16d2c32c	249	// Check input parameters.\r
4a567c96	250	//\r
16d2c32c	251	if (Cert == NULL \|\| SubjectSize == NULL) {\r
	252	return FALSE;\r
	253	}\r
4a567c96	254	\r
4a567c96	255	X509Cert = NULL;\r
	256	\r
	257	//\r
	258	// Read DER-encoded X509 Certificate and Construct X509 object.\r
	259	//\r
b7d320f8	260	Status = X509ConstructCertificate (Cert, CertSize, (UINT8 **) &X509Cert);\r
b7d320f8	261	if ((X509Cert == NULL) \|\| (!Status)) {\r
dda39f3a	262	Status = FALSE;\r
4a567c96	263	goto _Exit;\r
	264	}\r
	265	\r
dda39f3a	266	Status = FALSE;\r
dda39f3a	267	\r
4a567c96	268	//\r
	269	// Retrieve subject name from certificate object.\r
	270	//\r
	271	X509Name = X509_get_subject_name (X509Cert);\r
dda39f3a	272	if (X509Name == NULL) {\r
	273	goto _Exit;\r
	274	}\r
	275	\r
4a567c96	276	if (*SubjectSize < (UINTN) X509Name->bytes->length) {\r
	277	*SubjectSize = (UINTN) X509Name->bytes->length;\r
	278	goto _Exit;\r
	279	}\r
	280	*SubjectSize = (UINTN) X509Name->bytes->length;\r
	281	if (CertSubject != NULL) {\r
6b8ebcb8	282	CopyMem (CertSubject, (UINT8 ) X509Name->bytes->data, SubjectSize);\r
4a567c96	283	Status = TRUE;\r
	284	}\r
	285	\r
	286	_Exit:\r
	287	//\r
	288	// Release Resources.\r
	289	//\r
dda39f3a	290	if (X509Cert != NULL) {\r
	291	X509_free (X509Cert);\r
	292	}\r
4a567c96	293	\r
	294	return Status;\r
	295	}\r
	296	\r
	297	/**\r
	298	Retrieve the RSA Public Key from one DER-encoded X509 certificate.\r
	299	\r
	300	@param[in] Cert Pointer to the DER-encoded X509 certificate.\r
	301	@param[in] CertSize Size of the X509 certificate in bytes.\r
	302	@param[out] RsaContext Pointer to new-generated RSA context which contain the retrieved\r
	303	RSA public key component. Use RsaFree() function to free the\r
	304	resource.\r
	305	\r
16d2c32c	306	If Cert is NULL, then return FALSE.\r
16d2c32c	307	If RsaContext is NULL, then return FALSE.\r
4a567c96	308	\r
	309	@retval TRUE RSA Public Key was retrieved successfully.\r
	310	@retval FALSE Fail to retrieve RSA public key from X509 certificate.\r
	311	\r
	312	**/\r
	313	BOOLEAN\r
	314	EFIAPI\r
	315	RsaGetPublicKeyFromX509 (\r
	316	IN CONST UINT8 *Cert,\r
	317	IN UINTN CertSize,\r
	318	OUT VOID **RsaContext\r
	319	)\r
	320	{\r
	321	BOOLEAN Status;\r
	322	EVP_PKEY *Pkey;\r
4a567c96	323	X509 *X509Cert;\r
16d2c32c	324	\r
4a567c96	325	//\r
16d2c32c	326	// Check input parameters.\r
4a567c96	327	//\r
16d2c32c	328	if (Cert == NULL \|\| RsaContext == NULL) {\r
	329	return FALSE;\r
	330	}\r
4a567c96	331	\r
4a567c96	332	Pkey = NULL;\r
4a567c96	333	X509Cert = NULL;\r
	334	\r
	335	//\r
	336	// Read DER-encoded X509 Certificate and Construct X509 object.\r
	337	//\r
b7d320f8	338	Status = X509ConstructCertificate (Cert, CertSize, (UINT8 **) &X509Cert);\r
b7d320f8	339	if ((X509Cert == NULL) \|\| (!Status)) {\r
dda39f3a	340	Status = FALSE;\r
4a567c96	341	goto _Exit;\r
	342	}\r
	343	\r
dda39f3a	344	Status = FALSE;\r
dda39f3a	345	\r
4a567c96	346	//\r
	347	// Retrieve and check EVP_PKEY data from X509 Certificate.\r
	348	//\r
	349	Pkey = X509_get_pubkey (X509Cert);\r
	350	if ((Pkey == NULL) \|\| (Pkey->type != EVP_PKEY_RSA)) {\r
	351	goto _Exit;\r
	352	}\r
	353	\r
	354	//\r
	355	// Duplicate RSA Context from the retrieved EVP_PKEY.\r
	356	//\r
	357	if ((*RsaContext = RSAPublicKey_dup (Pkey->pkey.rsa)) != NULL) {\r
	358	Status = TRUE;\r
	359	}\r
	360	\r
	361	_Exit:\r
	362	//\r
	363	// Release Resources.\r
	364	//\r
dda39f3a	365	if (X509Cert != NULL) {\r
	366	X509_free (X509Cert);\r
	367	}\r
	368	\r
	369	if (Pkey != NULL) {\r
	370	EVP_PKEY_free (Pkey);\r
	371	} \r
4a567c96	372	\r
	373	return Status;\r
	374	}\r
	375	\r
	376	/**\r
	377	Verify one X509 certificate was issued by the trusted CA.\r
	378	\r
	379	@param[in] Cert Pointer to the DER-encoded X509 certificate to be verified.\r
	380	@param[in] CertSize Size of the X509 certificate in bytes.\r
	381	@param[in] CACert Pointer to the DER-encoded trusted CA certificate.\r
	382	@param[in] CACertSize Size of the CA Certificate in bytes.\r
	383	\r
16d2c32c	384	If Cert is NULL, then return FALSE.\r
16d2c32c	385	If CACert is NULL, then return FALSE.\r
4a567c96	386	\r
	387	@retval TRUE The certificate was issued by the trusted CA.\r
	388	@retval FALSE Invalid certificate or the certificate was not issued by the given\r
	389	trusted CA.\r
	390	\r
	391	**/\r
	392	BOOLEAN\r
	393	EFIAPI\r
	394	X509VerifyCert (\r
	395	IN CONST UINT8 *Cert,\r
	396	IN UINTN CertSize,\r
	397	IN CONST UINT8 *CACert,\r
	398	IN UINTN CACertSize\r
	399	)\r
	400	{\r
	401	BOOLEAN Status;\r
4a567c96	402	X509 *X509Cert;\r
	403	X509 *X509CACert;\r
	404	X509_STORE *CertStore;\r
	405	X509_STORE_CTX CertCtx;\r
16d2c32c	406	\r
4a567c96	407	//\r
16d2c32c	408	// Check input parameters.\r
4a567c96	409	//\r
16d2c32c	410	if (Cert == NULL \|\| CACert == NULL) {\r
	411	return FALSE;\r
	412	}\r
4a567c96	413	\r
4a567c96	414	Status = FALSE;\r
4a567c96	415	X509Cert = NULL;\r
	416	X509CACert = NULL;\r
	417	CertStore = NULL;\r
	418	\r
	419	//\r
	420	// Register & Initialize necessary digest algorithms for certificate verification.\r
	421	//\r
dda39f3a	422	if (EVP_add_digest (EVP_md5 ()) == 0) {\r
	423	goto _Exit;\r
	424	}\r
	425	if (EVP_add_digest (EVP_sha1 ()) == 0) {\r
	426	goto _Exit;\r
	427	}\r
	428	if (EVP_add_digest (EVP_sha256 ()) == 0) {\r
	429	goto _Exit;\r
	430	}\r
4a567c96	431	\r
	432	//\r
	433	// Read DER-encoded certificate to be verified and Construct X509 object.\r
	434	//\r
b7d320f8	435	Status = X509ConstructCertificate (Cert, CertSize, (UINT8 **) &X509Cert);\r
b7d320f8	436	if ((X509Cert == NULL) \|\| (!Status)) {\r
dda39f3a	437	Status = FALSE;\r
4a567c96	438	goto _Exit;\r
	439	}\r
	440	\r
	441	//\r
	442	// Read DER-encoded root certificate and Construct X509 object.\r
	443	//\r
b7d320f8	444	Status = X509ConstructCertificate (CACert, CACertSize, (UINT8 **) &X509CACert);\r
b7d320f8	445	if ((X509CACert == NULL) \|\| (!Status)) {\r
dda39f3a	446	Status = FALSE;\r
4a567c96	447	goto _Exit;\r
	448	}\r
	449	\r
dda39f3a	450	Status = FALSE;\r
dda39f3a	451	\r
4a567c96	452	//\r
	453	// Set up X509 Store for trusted certificate.\r
	454	//\r
	455	CertStore = X509_STORE_new ();\r
	456	if (CertStore == NULL) {\r
	457	goto _Exit;\r
	458	}\r
	459	if (!(X509_STORE_add_cert (CertStore, X509CACert))) {\r
	460	goto _Exit;\r
	461	}\r
	462	\r
	463	//\r
	464	// Set up X509_STORE_CTX for the subsequent verification operation.\r
	465	//\r
	466	if (!X509_STORE_CTX_init (&CertCtx, CertStore, X509Cert, NULL)) {\r
	467	goto _Exit;\r
	468	}\r
	469	\r
	470	//\r
	471	// X509 Certificate Verification.\r
	472	//\r
	473	Status = (BOOLEAN) X509_verify_cert (&CertCtx);\r
da9e7418	474	X509_STORE_CTX_cleanup (&CertCtx);\r
4a567c96	475	\r
	476	_Exit:\r
	477	//\r
	478	// Release Resources.\r
	479	//\r
dda39f3a	480	if (X509Cert != NULL) {\r
	481	X509_free (X509Cert);\r
	482	}\r
	483	\r
	484	if (X509CACert != NULL) {\r
	485	X509_free (X509CACert);\r
	486	}\r
4a567c96	487	\r
dda39f3a	488	if (CertStore != NULL) {\r
	489	X509_STORE_free (CertStore);\r
	490	}\r
	491	\r
4a567c96	492	return Status;\r
4a567c96	493	}\r
12d95665 LQ	494	\r
	495	/**\r
	496	Retrieve the TBSCertificate from one given X.509 certificate.\r
	497	\r
	498	@param[in] Cert Pointer to the given DER-encoded X509 certificate.\r
	499	@param[in] CertSize Size of the X509 certificate in bytes.\r
	500	@param[out] TBSCert DER-Encoded To-Be-Signed certificate.\r
	501	@param[out] TBSCertSize Size of the TBS certificate in bytes.\r
	502	\r
	503	If Cert is NULL, then return FALSE.\r
	504	If TBSCert is NULL, then return FALSE.\r
	505	If TBSCertSize is NULL, then return FALSE.\r
	506	\r
	507	@retval TRUE The TBSCertificate was retrieved successfully.\r
	508	@retval FALSE Invalid X.509 certificate.\r
	509	\r
	510	**/\r
	511	BOOLEAN\r
	512	EFIAPI\r
	513	X509GetTBSCert (\r
	514	IN CONST UINT8 *Cert,\r
	515	IN UINTN CertSize,\r
	516	OUT UINT8 **TBSCert,\r
	517	OUT UINTN *TBSCertSize\r
	518	)\r
	519	{\r
	520	CONST UINT8 *Temp;\r
	521	INTN Asn1Tag;\r
	522	INTN ObjClass;\r
	523	UINTN Length;\r
	524	\r
	525	//\r
	526	// Check input parameters.\r
	527	//\r
1463ce18 QL	528	if ((Cert == NULL) \|\| (TBSCert == NULL) \|\|\r
1463ce18 QL	529	(TBSCertSize == NULL) \|\| (CertSize > INT_MAX)) {\r
12d95665 LQ	530	return FALSE;\r
	531	}\r
	532	\r
	533	//\r
	534	// An X.509 Certificate is: (defined in RFC3280)\r
	535	// Certificate ::= SEQUENCE {\r
	536	// tbsCertificate TBSCertificate,\r
	537	// signatureAlgorithm AlgorithmIdentifier,\r
	538	// signature BIT STRING }\r
	539	//\r
	540	// and\r
	541	//\r
	542	// TBSCertificate ::= SEQUENCE {\r
	543	// version [0] Version DEFAULT v1,\r
	544	// ...\r
	545	// }\r
	546	//\r
	547	// So we can just ASN1-parse the x.509 DER-encoded data. If we strip\r
	548	// the first SEQUENCE, the second SEQUENCE is the TBSCertificate.\r
	549	//\r
	550	Temp = Cert;\r
	551	ASN1_get_object (&Temp, (long )&Length, (int )&Asn1Tag, (int *)&ObjClass, (long)CertSize);\r
	552	\r
	553	if (Asn1Tag != V_ASN1_SEQUENCE) {\r
	554	return FALSE;\r
	555	}\r
	556	\r
	557	TBSCert = (UINT8 )Temp;\r
	558	\r
	559	ASN1_get_object (&Temp, (long )&Length, (int )&Asn1Tag, (int *)&ObjClass, (long)Length);\r
	560	//\r
	561	// Verify the parsed TBSCertificate is one correct SEQUENCE data.\r
	562	//\r
	563	if (Asn1Tag != V_ASN1_SEQUENCE) {\r
	564	return FALSE;\r
	565	}\r
	566	\r
	567	TBSCertSize = Length + (Temp - TBSCert);\r
	568	\r
	569	return TRUE;\r
	570	}\r