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