2 X.509 Certificate Handler Wrapper Implementation over OpenSSL.
4 Copyright (c) 2010 - 2015, 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
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.
15 #include "InternalCryptLib.h"
16 #include <openssl/x509.h>
17 #include <openssl/rsa.h>
20 Construct a X509 object from DER-encoded certificate data.
22 If Cert is NULL, then return FALSE.
23 If SingleX509Cert is NULL, then return FALSE.
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.
29 @retval TRUE The X509 object generation succeeded.
30 @retval FALSE The operation failed.
35 X509ConstructCertificate (
38 OUT UINT8
**SingleX509Cert
45 // Check input parameters.
47 if (Cert
== NULL
|| SingleX509Cert
== NULL
|| CertSize
> INT_MAX
) {
52 // Read DER-encoded X509 Certificate and Construct X509 object.
55 X509Cert
= d2i_X509 (NULL
, &Temp
, (long) CertSize
);
56 if (X509Cert
== NULL
) {
60 *SingleX509Cert
= (UINT8
*) X509Cert
;
66 Construct a X509 stack object from a list of DER-encoded certificate data.
68 If X509Stack is NULL, then return FALSE.
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().
77 @retval TRUE The X509 stack construction succeeded.
78 @retval FALSE The construction operation failed.
83 X509ConstructCertificateStack (
84 IN OUT UINT8
**X509Stack
,
91 STACK_OF(X509
) *CertStack
;
97 // Check input parameters.
99 if (X509Stack
== NULL
) {
106 // Initialize X509 stack object.
108 CertStack
= (STACK_OF(X509
) *) (*X509Stack
);
109 if (CertStack
== NULL
) {
110 CertStack
= sk_X509_new_null ();
111 if (CertStack
== NULL
) {
116 VA_START (Args
, X509Stack
);
118 for (Index
= 0; ; Index
++) {
120 // If Cert is NULL, then it is the end of the list.
122 Cert
= VA_ARG (Args
, UINT8
*);
127 CertSize
= VA_ARG (Args
, UINTN
);
133 // Construct X509 Object from the given DER-encoded certificate data.
136 Status
= X509ConstructCertificate (
137 (CONST UINT8
*) Cert
,
142 if (X509Cert
!= NULL
) {
143 X509_free (X509Cert
);
149 // Insert the new X509 object into X509 stack object.
151 sk_X509_push (CertStack
, X509Cert
);
157 sk_X509_pop_free (CertStack
, X509_free
);
159 *X509Stack
= (UINT8
*) CertStack
;
166 Release the specified X509 object.
168 If X509Cert is NULL, then return FALSE.
170 @param[in] X509Cert Pointer to the X509 object to be released.
180 // Check input parameters.
182 if (X509Cert
== NULL
) {
187 // Free OpenSSL X509 object.
189 X509_free ((X509
*) X509Cert
);
193 Release the specified X509 stack object.
195 If X509Stack is NULL, then return FALSE.
197 @param[in] X509Stack Pointer to the X509 stack object to be released.
207 // Check input parameters.
209 if (X509Stack
== NULL
) {
214 // Free OpenSSL X509 stack object.
216 sk_X509_pop_free ((STACK_OF(X509
) *) X509Stack
, X509_free
);
220 Retrieve the subject bytes from one X.509 certificate.
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.
228 If Cert is NULL, then return FALSE.
229 If SubjectSize is NULL, then return FALSE.
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.
239 IN CONST UINT8
*Cert
,
241 OUT UINT8
*CertSubject
,
242 IN OUT UINTN
*SubjectSize
251 // Check input parameters.
253 if (Cert
== NULL
|| SubjectSize
== NULL
) {
260 // Read DER-encoded X509 Certificate and Construct X509 object.
262 Status
= X509ConstructCertificate (Cert
, CertSize
, (UINT8
**) &X509Cert
);
263 if ((X509Cert
== NULL
) || (!Status
)) {
271 // Retrieve subject name from certificate object.
273 X509Name
= X509_get_subject_name (X509Cert
);
274 if (X509Name
== NULL
) {
278 X509NameSize
= i2d_X509_NAME(X509Name
, NULL
);
279 if (*SubjectSize
< X509NameSize
) {
280 *SubjectSize
= X509NameSize
;
283 *SubjectSize
= X509NameSize
;
284 if (CertSubject
!= NULL
) {
285 i2d_X509_NAME(X509Name
, &CertSubject
);
291 // Release Resources.
293 if (X509Cert
!= NULL
) {
294 X509_free (X509Cert
);
301 Retrieve the RSA Public Key from one DER-encoded X509 certificate.
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] RsaContext Pointer to new-generated RSA context which contain the retrieved
306 RSA public key component. Use RsaFree() function to free the
309 If Cert is NULL, then return FALSE.
310 If RsaContext is NULL, then return FALSE.
312 @retval TRUE RSA Public Key was retrieved successfully.
313 @retval FALSE Fail to retrieve RSA public key from X509 certificate.
318 RsaGetPublicKeyFromX509 (
319 IN CONST UINT8
*Cert
,
321 OUT VOID
**RsaContext
329 // Check input parameters.
331 if (Cert
== NULL
|| RsaContext
== NULL
) {
339 // Read DER-encoded X509 Certificate and Construct X509 object.
341 Status
= X509ConstructCertificate (Cert
, CertSize
, (UINT8
**) &X509Cert
);
342 if ((X509Cert
== NULL
) || (!Status
)) {
350 // Retrieve and check EVP_PKEY data from X509 Certificate.
352 Pkey
= X509_get_pubkey (X509Cert
);
353 if ((Pkey
== NULL
) || (Pkey
->type
!= EVP_PKEY_RSA
)) {
358 // Duplicate RSA Context from the retrieved EVP_PKEY.
360 if ((*RsaContext
= RSAPublicKey_dup (Pkey
->pkey
.rsa
)) != NULL
) {
366 // Release Resources.
368 if (X509Cert
!= NULL
) {
369 X509_free (X509Cert
);
373 EVP_PKEY_free (Pkey
);
380 Verify one X509 certificate was issued by the trusted CA.
382 @param[in] Cert Pointer to the DER-encoded X509 certificate to be verified.
383 @param[in] CertSize Size of the X509 certificate in bytes.
384 @param[in] CACert Pointer to the DER-encoded trusted CA certificate.
385 @param[in] CACertSize Size of the CA Certificate in bytes.
387 If Cert is NULL, then return FALSE.
388 If CACert is NULL, then return FALSE.
390 @retval TRUE The certificate was issued by the trusted CA.
391 @retval FALSE Invalid certificate or the certificate was not issued by the given
398 IN CONST UINT8
*Cert
,
400 IN CONST UINT8
*CACert
,
407 X509_STORE
*CertStore
;
408 X509_STORE_CTX CertCtx
;
411 // Check input parameters.
413 if (Cert
== NULL
|| CACert
== NULL
) {
423 // Register & Initialize necessary digest algorithms for certificate verification.
425 if (EVP_add_digest (EVP_md5 ()) == 0) {
428 if (EVP_add_digest (EVP_sha1 ()) == 0) {
431 if (EVP_add_digest (EVP_sha256 ()) == 0) {
436 // Read DER-encoded certificate to be verified and Construct X509 object.
438 Status
= X509ConstructCertificate (Cert
, CertSize
, (UINT8
**) &X509Cert
);
439 if ((X509Cert
== NULL
) || (!Status
)) {
445 // Read DER-encoded root certificate and Construct X509 object.
447 Status
= X509ConstructCertificate (CACert
, CACertSize
, (UINT8
**) &X509CACert
);
448 if ((X509CACert
== NULL
) || (!Status
)) {
456 // Set up X509 Store for trusted certificate.
458 CertStore
= X509_STORE_new ();
459 if (CertStore
== NULL
) {
462 if (!(X509_STORE_add_cert (CertStore
, X509CACert
))) {
467 // Allow partial certificate chains, terminated by a non-self-signed but
468 // still trusted intermediate certificate. Also disable time checks.
470 X509_STORE_set_flags (CertStore
,
471 X509_V_FLAG_PARTIAL_CHAIN
| X509_V_FLAG_NO_CHECK_TIME
);
474 // Set up X509_STORE_CTX for the subsequent verification operation.
476 if (!X509_STORE_CTX_init (&CertCtx
, CertStore
, X509Cert
, NULL
)) {
481 // X509 Certificate Verification.
483 Status
= (BOOLEAN
) X509_verify_cert (&CertCtx
);
484 X509_STORE_CTX_cleanup (&CertCtx
);
488 // Release Resources.
490 if (X509Cert
!= NULL
) {
491 X509_free (X509Cert
);
494 if (X509CACert
!= NULL
) {
495 X509_free (X509CACert
);
498 if (CertStore
!= NULL
) {
499 X509_STORE_free (CertStore
);
506 Retrieve the TBSCertificate from one given X.509 certificate.
508 @param[in] Cert Pointer to the given DER-encoded X509 certificate.
509 @param[in] CertSize Size of the X509 certificate in bytes.
510 @param[out] TBSCert DER-Encoded To-Be-Signed certificate.
511 @param[out] TBSCertSize Size of the TBS certificate in bytes.
513 If Cert is NULL, then return FALSE.
514 If TBSCert is NULL, then return FALSE.
515 If TBSCertSize is NULL, then return FALSE.
517 @retval TRUE The TBSCertificate was retrieved successfully.
518 @retval FALSE Invalid X.509 certificate.
524 IN CONST UINT8
*Cert
,
527 OUT UINTN
*TBSCertSize
536 // Check input parameters.
538 if ((Cert
== NULL
) || (TBSCert
== NULL
) ||
539 (TBSCertSize
== NULL
) || (CertSize
> INT_MAX
)) {
544 // An X.509 Certificate is: (defined in RFC3280)
545 // Certificate ::= SEQUENCE {
546 // tbsCertificate TBSCertificate,
547 // signatureAlgorithm AlgorithmIdentifier,
548 // signature BIT STRING }
552 // TBSCertificate ::= SEQUENCE {
553 // version [0] Version DEFAULT v1,
557 // So we can just ASN1-parse the x.509 DER-encoded data. If we strip
558 // the first SEQUENCE, the second SEQUENCE is the TBSCertificate.
561 ASN1_get_object (&Temp
, (long *)&Length
, (int *)&Asn1Tag
, (int *)&ObjClass
, (long)CertSize
);
563 if (Asn1Tag
!= V_ASN1_SEQUENCE
) {
567 *TBSCert
= (UINT8
*)Temp
;
569 ASN1_get_object (&Temp
, (long *)&Length
, (int *)&Asn1Tag
, (int *)&ObjClass
, (long)Length
);
571 // Verify the parsed TBSCertificate is one correct SEQUENCE data.
573 if (Asn1Tag
!= V_ASN1_SEQUENCE
) {
577 *TBSCertSize
= Length
+ (Temp
- *TBSCert
);