Reformat/tidy some of the ASN1 code.
[openssl.git] / crypto / x509 / x509_lu.c
1 /* crypto/x509/x509_lu.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #include <stdio.h>
60 #include "cryptlib.h"
61 #include <openssl/lhash.h>
62 #include <openssl/x509.h>
63 #include <openssl/x509v3.h>
64
65 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method)
66         {
67         X509_LOOKUP *ret;
68
69         ret=(X509_LOOKUP *)OPENSSL_malloc(sizeof(X509_LOOKUP));
70         if (ret == NULL) return NULL;
71
72         ret->init=0;
73         ret->skip=0;
74         ret->method=method;
75         ret->method_data=NULL;
76         ret->store_ctx=NULL;
77         if ((method->new_item != NULL) && !method->new_item(ret))
78                 {
79                 OPENSSL_free(ret);
80                 return NULL;
81                 }
82         return ret;
83         }
84
85 void X509_LOOKUP_free(X509_LOOKUP *ctx)
86         {
87         if (ctx == NULL) return;
88         if (    (ctx->method != NULL) &&
89                 (ctx->method->free != NULL))
90                 ctx->method->free(ctx);
91         OPENSSL_free(ctx);
92         }
93
94 int X509_LOOKUP_init(X509_LOOKUP *ctx)
95         {
96         if (ctx->method == NULL) return 0;
97         if (ctx->method->init != NULL)
98                 return ctx->method->init(ctx);
99         else
100                 return 1;
101         }
102
103 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx)
104         {
105         if (ctx->method == NULL) return 0;
106         if (ctx->method->shutdown != NULL)
107                 return ctx->method->shutdown(ctx);
108         else
109                 return 1;
110         }
111
112 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc, long argl,
113              char **ret)
114         {
115         if (ctx->method == NULL) return -1;
116         if (ctx->method->ctrl != NULL)
117                 return ctx->method->ctrl(ctx,cmd,argc,argl,ret);
118         else
119                 return 1;
120         }
121
122 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
123              X509_OBJECT *ret)
124         {
125         if ((ctx->method == NULL) || (ctx->method->get_by_subject == NULL))
126                 return X509_LU_FAIL;
127         if (ctx->skip) return 0;
128         return ctx->method->get_by_subject(ctx,type,name,ret);
129         }
130
131 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
132              ASN1_INTEGER *serial, X509_OBJECT *ret)
133         {
134         if ((ctx->method == NULL) ||
135                 (ctx->method->get_by_issuer_serial == NULL))
136                 return X509_LU_FAIL;
137         return ctx->method->get_by_issuer_serial(ctx,type,name,serial,ret);
138         }
139
140 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
141              unsigned char *bytes, int len, X509_OBJECT *ret)
142         {
143         if ((ctx->method == NULL) || (ctx->method->get_by_fingerprint == NULL))
144                 return X509_LU_FAIL;
145         return ctx->method->get_by_fingerprint(ctx,type,bytes,len,ret);
146         }
147
148 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str, int len,
149              X509_OBJECT *ret)
150         {
151         if ((ctx->method == NULL) || (ctx->method->get_by_alias == NULL))
152                 return X509_LU_FAIL;
153         return ctx->method->get_by_alias(ctx,type,str,len,ret);
154         }
155
156   
157 static int x509_object_cmp(const X509_OBJECT * const *a, const X509_OBJECT * const *b)
158         {
159         int ret;
160
161         ret=((*a)->type - (*b)->type);
162         if (ret) return ret;
163         switch ((*a)->type)
164                 {
165         case X509_LU_X509:
166                 ret=X509_subject_name_cmp((*a)->data.x509,(*b)->data.x509);
167                 break;
168         case X509_LU_CRL:
169                 ret=X509_CRL_cmp((*a)->data.crl,(*b)->data.crl);
170                 break;
171         default:
172                 /* abort(); */
173                 return 0;
174                 }
175         return ret;
176         }
177
178 X509_STORE *X509_STORE_new(void)
179         {
180         X509_STORE *ret;
181
182         if ((ret=(X509_STORE *)OPENSSL_malloc(sizeof(X509_STORE))) == NULL)
183                 return NULL;
184         ret->objs = sk_X509_OBJECT_new(x509_object_cmp);
185         ret->cache=1;
186         ret->get_cert_methods=sk_X509_LOOKUP_new_null();
187         ret->verify=0;
188         ret->verify_cb=0;
189
190         ret->purpose = 0;
191         ret->trust = 0;
192
193         ret->flags = 0;
194
195         ret->get_issuer = 0;
196         ret->check_issued = 0;
197         ret->check_revocation = 0;
198         ret->get_crl = 0;
199         ret->check_crl = 0;
200         ret->cert_crl = 0;
201         ret->cleanup = 0;
202
203         CRYPTO_new_ex_data(CRYPTO_EX_INDEX_X509_STORE, ret, &ret->ex_data);
204         ret->references=1;
205         ret->depth=0;
206         return ret;
207         }
208
209 static void cleanup(X509_OBJECT *a)
210         {
211         if (a->type == X509_LU_X509)
212                 {
213                 X509_free(a->data.x509);
214                 }
215         else if (a->type == X509_LU_CRL)
216                 {
217                 X509_CRL_free(a->data.crl);
218                 }
219         else
220                 {
221                 /* abort(); */
222                 }
223
224         OPENSSL_free(a);
225         }
226
227 void X509_STORE_free(X509_STORE *vfy)
228         {
229         int i;
230         STACK_OF(X509_LOOKUP) *sk;
231         X509_LOOKUP *lu;
232
233         if (vfy == NULL)
234             return;
235
236         sk=vfy->get_cert_methods;
237         for (i=0; i<sk_X509_LOOKUP_num(sk); i++)
238                 {
239                 lu=sk_X509_LOOKUP_value(sk,i);
240                 X509_LOOKUP_shutdown(lu);
241                 X509_LOOKUP_free(lu);
242                 }
243         sk_X509_LOOKUP_free(sk);
244         sk_X509_OBJECT_pop_free(vfy->objs, cleanup);
245
246         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_X509_STORE, vfy, &vfy->ex_data);
247         OPENSSL_free(vfy);
248         }
249
250 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m)
251         {
252         int i;
253         STACK_OF(X509_LOOKUP) *sk;
254         X509_LOOKUP *lu;
255
256         sk=v->get_cert_methods;
257         for (i=0; i<sk_X509_LOOKUP_num(sk); i++)
258                 {
259                 lu=sk_X509_LOOKUP_value(sk,i);
260                 if (m == lu->method)
261                         {
262                         return lu;
263                         }
264                 }
265         /* a new one */
266         lu=X509_LOOKUP_new(m);
267         if (lu == NULL)
268                 return NULL;
269         else
270                 {
271                 lu->store_ctx=v;
272                 if (sk_X509_LOOKUP_push(v->get_cert_methods,lu))
273                         return lu;
274                 else
275                         {
276                         X509_LOOKUP_free(lu);
277                         return NULL;
278                         }
279                 }
280         }
281
282 int X509_STORE_get_by_subject(X509_STORE_CTX *vs, int type, X509_NAME *name,
283              X509_OBJECT *ret)
284         {
285         X509_STORE *ctx=vs->ctx;
286         X509_LOOKUP *lu;
287         X509_OBJECT stmp,*tmp;
288         int i,j;
289
290         tmp=X509_OBJECT_retrieve_by_subject(ctx->objs,type,name);
291
292         if (tmp == NULL)
293                 {
294                 for (i=vs->current_method; i<sk_X509_LOOKUP_num(ctx->get_cert_methods); i++)
295                         {
296                         lu=sk_X509_LOOKUP_value(ctx->get_cert_methods,i);
297                         j=X509_LOOKUP_by_subject(lu,type,name,&stmp);
298                         if (j < 0)
299                                 {
300                                 vs->current_method=j;
301                                 return j;
302                                 }
303                         else if (j)
304                                 {
305                                 tmp= &stmp;
306                                 break;
307                                 }
308                         }
309                 vs->current_method=0;
310                 if (tmp == NULL)
311                         return 0;
312                 }
313
314 /*      if (ret->data.ptr != NULL)
315                 X509_OBJECT_free_contents(ret); */
316
317         ret->type=tmp->type;
318         ret->data.ptr=tmp->data.ptr;
319
320         X509_OBJECT_up_ref_count(ret);
321
322         return 1;
323         }
324
325 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x)
326         {
327         X509_OBJECT *obj;
328         int ret=1;
329
330         if (x == NULL) return 0;
331         obj=(X509_OBJECT *)OPENSSL_malloc(sizeof(X509_OBJECT));
332         if (obj == NULL)
333                 {
334                 X509err(X509_F_X509_STORE_ADD_CERT,ERR_R_MALLOC_FAILURE);
335                 return 0;
336                 }
337         obj->type=X509_LU_X509;
338         obj->data.x509=x;
339
340         CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
341
342         X509_OBJECT_up_ref_count(obj);
343
344
345         if (X509_OBJECT_retrieve_match(ctx->objs, obj))
346                 {
347                 X509_OBJECT_free_contents(obj);
348                 OPENSSL_free(obj);
349                 X509err(X509_F_X509_STORE_ADD_CERT,X509_R_CERT_ALREADY_IN_HASH_TABLE);
350                 ret=0;
351                 } 
352         else sk_X509_OBJECT_push(ctx->objs, obj);
353
354         CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
355
356         return ret;
357         }
358
359 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x)
360         {
361         X509_OBJECT *obj;
362         int ret=1;
363
364         if (x == NULL) return 0;
365         obj=(X509_OBJECT *)OPENSSL_malloc(sizeof(X509_OBJECT));
366         if (obj == NULL)
367                 {
368                 X509err(X509_F_X509_STORE_ADD_CRL,ERR_R_MALLOC_FAILURE);
369                 return 0;
370                 }
371         obj->type=X509_LU_CRL;
372         obj->data.crl=x;
373
374         CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
375
376         X509_OBJECT_up_ref_count(obj);
377
378         if (X509_OBJECT_retrieve_match(ctx->objs, obj))
379                 {
380                 X509_OBJECT_free_contents(obj);
381                 OPENSSL_free(obj);
382                 X509err(X509_F_X509_STORE_ADD_CRL,X509_R_CERT_ALREADY_IN_HASH_TABLE);
383                 ret=0;
384                 }
385         else sk_X509_OBJECT_push(ctx->objs, obj);
386
387         CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
388
389         return ret;
390         }
391
392 void X509_OBJECT_up_ref_count(X509_OBJECT *a)
393         {
394         switch (a->type)
395                 {
396         case X509_LU_X509:
397                 CRYPTO_add(&a->data.x509->references,1,CRYPTO_LOCK_X509);
398                 break;
399         case X509_LU_CRL:
400                 CRYPTO_add(&a->data.crl->references,1,CRYPTO_LOCK_X509_CRL);
401                 break;
402                 }
403         }
404
405 void X509_OBJECT_free_contents(X509_OBJECT *a)
406         {
407         switch (a->type)
408                 {
409         case X509_LU_X509:
410                 X509_free(a->data.x509);
411                 break;
412         case X509_LU_CRL:
413                 X509_CRL_free(a->data.crl);
414                 break;
415                 }
416         }
417
418 int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, int type,
419              X509_NAME *name)
420         {
421         X509_OBJECT stmp;
422         X509 x509_s;
423         X509_CINF cinf_s;
424         X509_CRL crl_s;
425         X509_CRL_INFO crl_info_s;
426
427         stmp.type=type;
428         switch (type)
429                 {
430         case X509_LU_X509:
431                 stmp.data.x509= &x509_s;
432                 x509_s.cert_info= &cinf_s;
433                 cinf_s.subject=name;
434                 break;
435         case X509_LU_CRL:
436                 stmp.data.crl= &crl_s;
437                 crl_s.crl= &crl_info_s;
438                 crl_info_s.issuer=name;
439                 break;
440         default:
441                 /* abort(); */
442                 return -1;
443                 }
444
445         return sk_X509_OBJECT_find(h,&stmp);
446         }
447
448 X509_OBJECT *X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h, int type,
449              X509_NAME *name)
450 {
451         int idx;
452         idx = X509_OBJECT_idx_by_subject(h, type, name);
453         if (idx==-1) return NULL;
454         return sk_X509_OBJECT_value(h, idx);
455 }
456
457 X509_OBJECT *X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h, X509_OBJECT *x)
458 {
459         int idx, i;
460         X509_OBJECT *obj;
461         idx = sk_X509_OBJECT_find(h, x);
462         if (idx == -1) return NULL;
463         if (x->type != X509_LU_X509) return sk_X509_OBJECT_value(h, idx);
464         for (i = idx; i < sk_X509_OBJECT_num(h); i++)
465                 {
466                 obj = sk_X509_OBJECT_value(h, i);
467                 if (x509_object_cmp((const X509_OBJECT **)&obj, (const X509_OBJECT **)&x))
468                         return NULL;
469                 if ((x->type != X509_LU_X509) || !X509_cmp(obj->data.x509, x->data.x509))
470                         return obj;
471                 }
472         return NULL;
473 }
474
475
476 /* Try to get issuer certificate from store. Due to limitations
477  * of the API this can only retrieve a single certificate matching
478  * a given subject name. However it will fill the cache with all
479  * matching certificates, so we can examine the cache for all 
480  * matches.
481  *
482  * Return values are:
483  *  1 lookup successful.
484  *  0 certificate not found.
485  * -1 some other error.
486  */
487
488
489 int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x)
490 {
491         X509_NAME *xn;
492         X509_OBJECT obj, *pobj;
493         int i, ok, idx;
494         xn=X509_get_issuer_name(x);
495         ok=X509_STORE_get_by_subject(ctx,X509_LU_X509,xn,&obj);
496         if (ok != X509_LU_X509)
497                 {
498                 if (ok == X509_LU_RETRY)
499                         {
500                         X509_OBJECT_free_contents(&obj);
501                         X509err(X509_F_X509_VERIFY_CERT,X509_R_SHOULD_RETRY);
502                         return -1;
503                         }
504                 else if (ok != X509_LU_FAIL)
505                         {
506                         X509_OBJECT_free_contents(&obj);
507                         /* not good :-(, break anyway */
508                         return -1;
509                         }
510                 return 0;
511                 }
512         /* If certificate matches all OK */
513         if (ctx->check_issued(ctx, x, obj.data.x509))
514                 {
515                 *issuer = obj.data.x509;
516                 return 1;
517                 }
518         X509_OBJECT_free_contents(&obj);
519         /* Else find index of first matching cert */
520         idx = X509_OBJECT_idx_by_subject(ctx->ctx->objs, X509_LU_X509, xn);
521         /* This shouldn't normally happen since we already have one match */
522         if (idx == -1) return 0;
523
524         /* Look through all matching certificates for a suitable issuer */
525         for (i = idx; i < sk_X509_OBJECT_num(ctx->ctx->objs); i++)
526                 {
527                 pobj = sk_X509_OBJECT_value(ctx->ctx->objs, i);
528                 /* See if we've ran out of matches */
529                 if (pobj->type != X509_LU_X509) return 0;
530                 if (X509_NAME_cmp(xn, X509_get_subject_name(pobj->data.x509))) return 0;
531                 if (ctx->check_issued(ctx, x, pobj->data.x509))
532                         {
533                         *issuer = pobj->data.x509;
534                         X509_OBJECT_up_ref_count(pobj);
535                         return 1;
536                         }
537                 }
538         return 0;
539 }
540
541 void X509_STORE_set_flags(X509_STORE *ctx, long flags)
542         {
543         ctx->flags |= flags;
544         }
545
546 int X509_STORE_set_purpose(X509_STORE *ctx, int purpose)
547         {
548         return X509_PURPOSE_set(&ctx->purpose, purpose);
549         }
550
551 int X509_STORE_set_trust(X509_STORE *ctx, int trust)
552         {
553         return X509_TRUST_set(&ctx->trust, trust);
554         }
555
556 IMPLEMENT_STACK_OF(X509_LOOKUP)
557 IMPLEMENT_STACK_OF(X509_OBJECT)