Purpose and trust setting functions for X509_STORE.
[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 static STACK_OF(CRYPTO_EX_DATA_FUNCS) *x509_store_meth=NULL;
66
67 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method)
68         {
69         X509_LOOKUP *ret;
70
71         ret=(X509_LOOKUP *)OPENSSL_malloc(sizeof(X509_LOOKUP));
72         if (ret == NULL) return NULL;
73
74         ret->init=0;
75         ret->skip=0;
76         ret->method=method;
77         ret->method_data=NULL;
78         ret->store_ctx=NULL;
79         if ((method->new_item != NULL) && !method->new_item(ret))
80                 {
81                 OPENSSL_free(ret);
82                 return NULL;
83                 }
84         return ret;
85         }
86
87 void X509_LOOKUP_free(X509_LOOKUP *ctx)
88         {
89         if (ctx == NULL) return;
90         if (    (ctx->method != NULL) &&
91                 (ctx->method->free != NULL))
92                 ctx->method->free(ctx);
93         OPENSSL_free(ctx);
94         }
95
96 int X509_LOOKUP_init(X509_LOOKUP *ctx)
97         {
98         if (ctx->method == NULL) return 0;
99         if (ctx->method->init != NULL)
100                 return ctx->method->init(ctx);
101         else
102                 return 1;
103         }
104
105 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx)
106         {
107         if (ctx->method == NULL) return 0;
108         if (ctx->method->shutdown != NULL)
109                 return ctx->method->shutdown(ctx);
110         else
111                 return 1;
112         }
113
114 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc, long argl,
115              char **ret)
116         {
117         if (ctx->method == NULL) return -1;
118         if (ctx->method->ctrl != NULL)
119                 return ctx->method->ctrl(ctx,cmd,argc,argl,ret);
120         else
121                 return 1;
122         }
123
124 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
125              X509_OBJECT *ret)
126         {
127         if ((ctx->method == NULL) || (ctx->method->get_by_subject == NULL))
128                 return X509_LU_FAIL;
129         if (ctx->skip) return 0;
130         return ctx->method->get_by_subject(ctx,type,name,ret);
131         }
132
133 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
134              ASN1_INTEGER *serial, X509_OBJECT *ret)
135         {
136         if ((ctx->method == NULL) ||
137                 (ctx->method->get_by_issuer_serial == NULL))
138                 return X509_LU_FAIL;
139         return ctx->method->get_by_issuer_serial(ctx,type,name,serial,ret);
140         }
141
142 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
143              unsigned char *bytes, int len, X509_OBJECT *ret)
144         {
145         if ((ctx->method == NULL) || (ctx->method->get_by_fingerprint == NULL))
146                 return X509_LU_FAIL;
147         return ctx->method->get_by_fingerprint(ctx,type,bytes,len,ret);
148         }
149
150 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str, int len,
151              X509_OBJECT *ret)
152         {
153         if ((ctx->method == NULL) || (ctx->method->get_by_alias == NULL))
154                 return X509_LU_FAIL;
155         return ctx->method->get_by_alias(ctx,type,str,len,ret);
156         }
157
158   
159 static int x509_object_cmp(const X509_OBJECT * const *a, const X509_OBJECT * const *b)
160         {
161         int ret;
162
163         ret=((*a)->type - (*b)->type);
164         if (ret) return ret;
165         switch ((*a)->type)
166                 {
167         case X509_LU_X509:
168                 ret=X509_subject_name_cmp((*a)->data.x509,(*b)->data.x509);
169                 break;
170         case X509_LU_CRL:
171                 ret=X509_CRL_cmp((*a)->data.crl,(*b)->data.crl);
172                 break;
173         default:
174                 /* abort(); */
175                 return 0;
176                 }
177         return ret;
178         }
179
180 X509_STORE *X509_STORE_new(void)
181         {
182         X509_STORE *ret;
183
184         if ((ret=(X509_STORE *)OPENSSL_malloc(sizeof(X509_STORE))) == NULL)
185                 return NULL;
186         ret->objs = sk_X509_OBJECT_new(x509_object_cmp);
187         ret->cache=1;
188         ret->get_cert_methods=sk_X509_LOOKUP_new_null();
189         ret->verify=0;
190         ret->verify_cb=0;
191
192         ret->purpose = 0;
193         ret->trust = 0;
194
195         ret->flags = 0;
196
197         ret->get_issuer = 0;
198         ret->check_issued = 0;
199         ret->check_revocation = 0;
200         ret->get_crl = 0;
201         ret->check_crl = 0;
202         ret->cert_crl = 0;
203         ret->cleanup = 0;
204
205         memset(&ret->ex_data,0,sizeof(CRYPTO_EX_DATA));
206         ret->references=1;
207         ret->depth=0;
208         return ret;
209         }
210
211 static void cleanup(X509_OBJECT *a)
212         {
213         if (a->type == X509_LU_X509)
214                 {
215                 X509_free(a->data.x509);
216                 }
217         else if (a->type == X509_LU_CRL)
218                 {
219                 X509_CRL_free(a->data.crl);
220                 }
221         else
222                 {
223                 /* abort(); */
224                 }
225
226         OPENSSL_free(a);
227         }
228
229 void X509_STORE_free(X509_STORE *vfy)
230         {
231         int i;
232         STACK_OF(X509_LOOKUP) *sk;
233         X509_LOOKUP *lu;
234
235         if (vfy == NULL)
236             return;
237
238         sk=vfy->get_cert_methods;
239         for (i=0; i<sk_X509_LOOKUP_num(sk); i++)
240                 {
241                 lu=sk_X509_LOOKUP_value(sk,i);
242                 X509_LOOKUP_shutdown(lu);
243                 X509_LOOKUP_free(lu);
244                 }
245         sk_X509_LOOKUP_free(sk);
246         sk_X509_OBJECT_pop_free(vfy->objs, cleanup);
247
248         CRYPTO_free_ex_data(x509_store_meth,vfy,&vfy->ex_data);
249         OPENSSL_free(vfy);
250         }
251
252 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m)
253         {
254         int i;
255         STACK_OF(X509_LOOKUP) *sk;
256         X509_LOOKUP *lu;
257
258         sk=v->get_cert_methods;
259         for (i=0; i<sk_X509_LOOKUP_num(sk); i++)
260                 {
261                 lu=sk_X509_LOOKUP_value(sk,i);
262                 if (m == lu->method)
263                         {
264                         return lu;
265                         }
266                 }
267         /* a new one */
268         lu=X509_LOOKUP_new(m);
269         if (lu == NULL)
270                 return NULL;
271         else
272                 {
273                 lu->store_ctx=v;
274                 if (sk_X509_LOOKUP_push(v->get_cert_methods,lu))
275                         return lu;
276                 else
277                         {
278                         X509_LOOKUP_free(lu);
279                         return NULL;
280                         }
281                 }
282         }
283
284 int X509_STORE_get_by_subject(X509_STORE_CTX *vs, int type, X509_NAME *name,
285              X509_OBJECT *ret)
286         {
287         X509_STORE *ctx=vs->ctx;
288         X509_LOOKUP *lu;
289         X509_OBJECT stmp,*tmp;
290         int i,j;
291
292         tmp=X509_OBJECT_retrieve_by_subject(ctx->objs,type,name);
293
294         if (tmp == NULL)
295                 {
296                 for (i=vs->current_method; i<sk_X509_LOOKUP_num(ctx->get_cert_methods); i++)
297                         {
298                         lu=sk_X509_LOOKUP_value(ctx->get_cert_methods,i);
299                         j=X509_LOOKUP_by_subject(lu,type,name,&stmp);
300                         if (j < 0)
301                                 {
302                                 vs->current_method=j;
303                                 return j;
304                                 }
305                         else if (j)
306                                 {
307                                 tmp= &stmp;
308                                 break;
309                                 }
310                         }
311                 vs->current_method=0;
312                 if (tmp == NULL)
313                         return 0;
314                 }
315
316 /*      if (ret->data.ptr != NULL)
317                 X509_OBJECT_free_contents(ret); */
318
319         ret->type=tmp->type;
320         ret->data.ptr=tmp->data.ptr;
321
322         X509_OBJECT_up_ref_count(ret);
323
324         return 1;
325         }
326
327 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x)
328         {
329         X509_OBJECT *obj;
330         int ret=1;
331
332         if (x == NULL) return 0;
333         obj=(X509_OBJECT *)OPENSSL_malloc(sizeof(X509_OBJECT));
334         if (obj == NULL)
335                 {
336                 X509err(X509_F_X509_STORE_ADD_CERT,ERR_R_MALLOC_FAILURE);
337                 return 0;
338                 }
339         obj->type=X509_LU_X509;
340         obj->data.x509=x;
341
342         CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
343
344         X509_OBJECT_up_ref_count(obj);
345
346
347         if (X509_OBJECT_retrieve_match(ctx->objs, obj))
348                 {
349                 X509_OBJECT_free_contents(obj);
350                 OPENSSL_free(obj);
351                 X509err(X509_F_X509_STORE_ADD_CERT,X509_R_CERT_ALREADY_IN_HASH_TABLE);
352                 ret=0;
353                 } 
354         else sk_X509_OBJECT_push(ctx->objs, obj);
355
356         CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
357
358         return ret;
359         }
360
361 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x)
362         {
363         X509_OBJECT *obj;
364         int ret=1;
365
366         if (x == NULL) return 0;
367         obj=(X509_OBJECT *)OPENSSL_malloc(sizeof(X509_OBJECT));
368         if (obj == NULL)
369                 {
370                 X509err(X509_F_X509_STORE_ADD_CRL,ERR_R_MALLOC_FAILURE);
371                 return 0;
372                 }
373         obj->type=X509_LU_CRL;
374         obj->data.crl=x;
375
376         CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
377
378         X509_OBJECT_up_ref_count(obj);
379
380         if (X509_OBJECT_retrieve_match(ctx->objs, obj))
381                 {
382                 X509_OBJECT_free_contents(obj);
383                 OPENSSL_free(obj);
384                 X509err(X509_F_X509_STORE_ADD_CRL,X509_R_CERT_ALREADY_IN_HASH_TABLE);
385                 ret=0;
386                 }
387         else sk_X509_OBJECT_push(ctx->objs, obj);
388
389         CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
390
391         return ret;
392         }
393
394 void X509_OBJECT_up_ref_count(X509_OBJECT *a)
395         {
396         switch (a->type)
397                 {
398         case X509_LU_X509:
399                 CRYPTO_add(&a->data.x509->references,1,CRYPTO_LOCK_X509);
400                 break;
401         case X509_LU_CRL:
402                 CRYPTO_add(&a->data.crl->references,1,CRYPTO_LOCK_X509_CRL);
403                 break;
404                 }
405         }
406
407 void X509_OBJECT_free_contents(X509_OBJECT *a)
408         {
409         switch (a->type)
410                 {
411         case X509_LU_X509:
412                 X509_free(a->data.x509);
413                 break;
414         case X509_LU_CRL:
415                 X509_CRL_free(a->data.crl);
416                 break;
417                 }
418         }
419
420 int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, int type,
421              X509_NAME *name)
422         {
423         X509_OBJECT stmp;
424         X509 x509_s;
425         X509_CINF cinf_s;
426         X509_CRL crl_s;
427         X509_CRL_INFO crl_info_s;
428
429         stmp.type=type;
430         switch (type)
431                 {
432         case X509_LU_X509:
433                 stmp.data.x509= &x509_s;
434                 x509_s.cert_info= &cinf_s;
435                 cinf_s.subject=name;
436                 break;
437         case X509_LU_CRL:
438                 stmp.data.crl= &crl_s;
439                 crl_s.crl= &crl_info_s;
440                 crl_info_s.issuer=name;
441                 break;
442         default:
443                 /* abort(); */
444                 return -1;
445                 }
446
447         return sk_X509_OBJECT_find(h,&stmp);
448         }
449
450 X509_OBJECT *X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h, int type,
451              X509_NAME *name)
452 {
453         int idx;
454         idx = X509_OBJECT_idx_by_subject(h, type, name);
455         if (idx==-1) return NULL;
456         return sk_X509_OBJECT_value(h, idx);
457 }
458
459 X509_OBJECT *X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h, X509_OBJECT *x)
460 {
461         int idx, i;
462         X509_OBJECT *obj;
463         idx = sk_X509_OBJECT_find(h, x);
464         if (idx == -1) return NULL;
465         if (x->type != X509_LU_X509) return sk_X509_OBJECT_value(h, idx);
466         for (i = idx; i < sk_X509_OBJECT_num(h); i++)
467                 {
468                 obj = sk_X509_OBJECT_value(h, i);
469                 if (x509_object_cmp((const X509_OBJECT **)&obj, (const X509_OBJECT **)&x))
470                         return NULL;
471                 if ((x->type != X509_LU_X509) || !X509_cmp(obj->data.x509, x->data.x509))
472                         return obj;
473                 }
474         return NULL;
475 }
476
477
478 /* Try to get issuer certificate from store. Due to limitations
479  * of the API this can only retrieve a single certificate matching
480  * a given subject name. However it will fill the cache with all
481  * matching certificates, so we can examine the cache for all 
482  * matches.
483  *
484  * Return values are:
485  *  1 lookup successful.
486  *  0 certificate not found.
487  * -1 some other error.
488  */
489
490
491 int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x)
492 {
493         X509_NAME *xn;
494         X509_OBJECT obj, *pobj;
495         int i, ok, idx;
496         xn=X509_get_issuer_name(x);
497         ok=X509_STORE_get_by_subject(ctx,X509_LU_X509,xn,&obj);
498         if (ok != X509_LU_X509)
499                 {
500                 if (ok == X509_LU_RETRY)
501                         {
502                         X509_OBJECT_free_contents(&obj);
503                         X509err(X509_F_X509_VERIFY_CERT,X509_R_SHOULD_RETRY);
504                         return -1;
505                         }
506                 else if (ok != X509_LU_FAIL)
507                         {
508                         X509_OBJECT_free_contents(&obj);
509                         /* not good :-(, break anyway */
510                         return -1;
511                         }
512                 return 0;
513                 }
514         /* If certificate matches all OK */
515         if (ctx->check_issued(ctx, x, obj.data.x509))
516                 {
517                 *issuer = obj.data.x509;
518                 return 1;
519                 }
520         X509_OBJECT_free_contents(&obj);
521         /* Else find index of first matching cert */
522         idx = X509_OBJECT_idx_by_subject(ctx->ctx->objs, X509_LU_X509, xn);
523         /* This shouldn't normally happen since we already have one match */
524         if (idx == -1) return 0;
525
526         /* Look through all matching certificates for a suitable issuer */
527         for (i = idx; i < sk_X509_OBJECT_num(ctx->ctx->objs); i++)
528                 {
529                 pobj = sk_X509_OBJECT_value(ctx->ctx->objs, i);
530                 /* See if we've ran out of matches */
531                 if (pobj->type != X509_LU_X509) return 0;
532                 if (X509_NAME_cmp(xn, X509_get_subject_name(pobj->data.x509))) return 0;
533                 if (ctx->check_issued(ctx, x, pobj->data.x509))
534                         {
535                         *issuer = pobj->data.x509;
536                         X509_OBJECT_up_ref_count(pobj);
537                         return 1;
538                         }
539                 }
540         return 0;
541 }
542
543 void X509_STORE_set_flags(X509_STORE *ctx, long flags)
544         {
545         ctx->flags |= flags;
546         }
547
548 int X509_STORE_set_purpose(X509_STORE *ctx, int purpose)
549         {
550         return X509_PURPOSE_set(&ctx->purpose, purpose);
551         }
552
553 int X509_STORE_set_trust(X509_STORE *ctx, int trust)
554         {
555         return X509_TRUST_set(&ctx->trust, trust);
556         }
557
558 IMPLEMENT_STACK_OF(X509_LOOKUP)
559 IMPLEMENT_STACK_OF(X509_OBJECT)