New documentation about things related to SSL_CIPHER. Submitted by Lutz Jaenicke...
[openssl.git] / crypto / objects / obj_dat.c
1 /* crypto/objects/obj_dat.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 <ctype.h>
61 #include "cryptlib.h"
62 #include <openssl/lhash.h>
63 #include <openssl/asn1.h>
64 #include <openssl/objects.h>
65
66 /* obj_dat.h is generated from objects.h by obj_dat.pl */
67 #ifndef NO_OBJECT
68 #include "obj_dat.h"
69 #else
70 /* You will have to load all the objects needed manually in the application */
71 #define NUM_NID 0
72 #define NUM_SN 0
73 #define NUM_LN 0
74 #define NUM_OBJ 0
75 static unsigned char lvalues[1];
76 static ASN1_OBJECT nid_objs[1];
77 static ASN1_OBJECT *sn_objs[1];
78 static ASN1_OBJECT *ln_objs[1];
79 static ASN1_OBJECT *obj_objs[1];
80 #endif
81
82 static int sn_cmp(const void *a, const void *b);
83 static int ln_cmp(const void *a, const void *b);
84 static int obj_cmp(const void *a, const void *b);
85 #define ADDED_DATA      0
86 #define ADDED_SNAME     1
87 #define ADDED_LNAME     2
88 #define ADDED_NID       3
89
90 typedef struct added_obj_st
91         {
92         int type;
93         ASN1_OBJECT *obj;
94         } ADDED_OBJ;
95
96 static int new_nid=NUM_NID;
97 static LHASH *added=NULL;
98
99 static int sn_cmp(const void *a, const void *b)
100         {
101         const ASN1_OBJECT * const *ap = a, * const *bp = b;
102         return(strcmp((*ap)->sn,(*bp)->sn));
103         }
104
105 static int ln_cmp(const void *a, const void *b)
106         { 
107         const ASN1_OBJECT * const *ap = a, * const *bp = b;
108         return(strcmp((*ap)->ln,(*bp)->ln));
109         }
110
111 static unsigned long add_hash(ADDED_OBJ *ca)
112         {
113         ASN1_OBJECT *a;
114         int i;
115         unsigned long ret=0;
116         unsigned char *p;
117
118         a=ca->obj;
119         switch (ca->type)
120                 {
121         case ADDED_DATA:
122                 ret=a->length<<20L;
123                 p=(unsigned char *)a->data;
124                 for (i=0; i<a->length; i++)
125                         ret^=p[i]<<((i*3)%24);
126                 break;
127         case ADDED_SNAME:
128                 ret=lh_strhash(a->sn);
129                 break;
130         case ADDED_LNAME:
131                 ret=lh_strhash(a->ln);
132                 break;
133         case ADDED_NID:
134                 ret=a->nid;
135                 break;
136         default:
137                 /* abort(); */
138                 return 0;
139                 }
140         ret&=0x3fffffffL;
141         ret|=ca->type<<30L;
142         return(ret);
143         }
144
145 static int add_cmp(ADDED_OBJ *ca, ADDED_OBJ *cb)
146         {
147         ASN1_OBJECT *a,*b;
148         int i;
149
150         i=ca->type-cb->type;
151         if (i) return(i);
152         a=ca->obj;
153         b=cb->obj;
154         switch (ca->type)
155                 {
156         case ADDED_DATA:
157                 i=(a->length - b->length);
158                 if (i) return(i);
159                 return(memcmp(a->data,b->data,a->length));
160         case ADDED_SNAME:
161                 if (a->sn == NULL) return(-1);
162                 else if (b->sn == NULL) return(1);
163                 else return(strcmp(a->sn,b->sn));
164         case ADDED_LNAME:
165                 if (a->ln == NULL) return(-1);
166                 else if (b->ln == NULL) return(1);
167                 else return(strcmp(a->ln,b->ln));
168         case ADDED_NID:
169                 return(a->nid-b->nid);
170         default:
171                 /* abort(); */
172                 return 0;
173                 }
174         return(1); /* should not get here */
175         }
176
177 static int init_added(void)
178         {
179         if (added != NULL) return(1);
180         added=lh_new(add_hash,add_cmp);
181         return(added != NULL);
182         }
183
184 static void cleanup1(ADDED_OBJ *a)
185         {
186         a->obj->nid=0;
187         a->obj->flags|=ASN1_OBJECT_FLAG_DYNAMIC|
188                         ASN1_OBJECT_FLAG_DYNAMIC_STRINGS|
189                         ASN1_OBJECT_FLAG_DYNAMIC_DATA;
190         }
191
192 static void cleanup2(ADDED_OBJ *a)
193         { a->obj->nid++; }
194
195 static void cleanup3(ADDED_OBJ *a)
196         {
197         if (--a->obj->nid == 0)
198                 ASN1_OBJECT_free(a->obj);
199         OPENSSL_free(a);
200         }
201
202 void OBJ_cleanup(void)
203         {
204         if (added == NULL) return;
205         added->down_load=0;
206         lh_doall(added,cleanup1); /* zero counters */
207         lh_doall(added,cleanup2); /* set counters */
208         lh_doall(added,cleanup3); /* free objects */
209         lh_free(added);
210         added=NULL;
211         }
212
213 int OBJ_new_nid(int num)
214         {
215         int i;
216
217         i=new_nid;
218         new_nid+=num;
219         return(i);
220         }
221
222 int OBJ_add_object(ASN1_OBJECT *obj)
223         {
224         ASN1_OBJECT *o;
225         ADDED_OBJ *ao[4]={NULL,NULL,NULL,NULL},*aop;
226         int i;
227
228         if (added == NULL)
229                 if (!init_added()) return(0);
230         if ((o=OBJ_dup(obj)) == NULL) goto err;
231         ao[ADDED_NID]=(ADDED_OBJ *)OPENSSL_malloc(sizeof(ADDED_OBJ));
232         if ((o->length != 0) && (obj->data != NULL))
233                 ao[ADDED_DATA]=(ADDED_OBJ *)OPENSSL_malloc(sizeof(ADDED_OBJ));
234         if (o->sn != NULL)
235                 ao[ADDED_SNAME]=(ADDED_OBJ *)OPENSSL_malloc(sizeof(ADDED_OBJ));
236         if (o->ln != NULL)
237                 ao[ADDED_LNAME]=(ADDED_OBJ *)OPENSSL_malloc(sizeof(ADDED_OBJ));
238
239         for (i=ADDED_DATA; i<=ADDED_NID; i++)
240                 {
241                 if (ao[i] != NULL)
242                         {
243                         ao[i]->type=i;
244                         ao[i]->obj=o;
245                         aop=(ADDED_OBJ *)lh_insert(added,ao[i]);
246                         /* memory leak, buit should not normally matter */
247                         if (aop != NULL)
248                                 OPENSSL_free(aop);
249                         }
250                 }
251         o->flags&= ~(ASN1_OBJECT_FLAG_DYNAMIC|ASN1_OBJECT_FLAG_DYNAMIC_STRINGS|
252                         ASN1_OBJECT_FLAG_DYNAMIC_DATA);
253
254         return(o->nid);
255 err:
256         for (i=ADDED_DATA; i<=ADDED_NID; i++)
257                 if (ao[i] != NULL) OPENSSL_free(ao[i]);
258         if (o != NULL) OPENSSL_free(o);
259         return(NID_undef);
260         }
261
262 ASN1_OBJECT *OBJ_nid2obj(int n)
263         {
264         ADDED_OBJ ad,*adp;
265         ASN1_OBJECT ob;
266
267         if ((n >= 0) && (n < NUM_NID))
268                 {
269                 if ((n != NID_undef) && (nid_objs[n].nid == NID_undef))
270                         {
271                         OBJerr(OBJ_F_OBJ_NID2OBJ,OBJ_R_UNKNOWN_NID);
272                         return(NULL);
273                         }
274                 return((ASN1_OBJECT *)&(nid_objs[n]));
275                 }
276         else if (added == NULL)
277                 return(NULL);
278         else
279                 {
280                 ad.type=ADDED_NID;
281                 ad.obj= &ob;
282                 ob.nid=n;
283                 adp=(ADDED_OBJ *)lh_retrieve(added,&ad);
284                 if (adp != NULL)
285                         return(adp->obj);
286                 else
287                         {
288                         OBJerr(OBJ_F_OBJ_NID2OBJ,OBJ_R_UNKNOWN_NID);
289                         return(NULL);
290                         }
291                 }
292         }
293
294 const char *OBJ_nid2sn(int n)
295         {
296         ADDED_OBJ ad,*adp;
297         ASN1_OBJECT ob;
298
299         if ((n >= 0) && (n < NUM_NID))
300                 {
301                 if ((n != NID_undef) && (nid_objs[n].nid == NID_undef))
302                         {
303                         OBJerr(OBJ_F_OBJ_NID2SN,OBJ_R_UNKNOWN_NID);
304                         return(NULL);
305                         }
306                 return(nid_objs[n].sn);
307                 }
308         else if (added == NULL)
309                 return(NULL);
310         else
311                 {
312                 ad.type=ADDED_NID;
313                 ad.obj= &ob;
314                 ob.nid=n;
315                 adp=(ADDED_OBJ *)lh_retrieve(added,&ad);
316                 if (adp != NULL)
317                         return(adp->obj->sn);
318                 else
319                         {
320                         OBJerr(OBJ_F_OBJ_NID2SN,OBJ_R_UNKNOWN_NID);
321                         return(NULL);
322                         }
323                 }
324         }
325
326 const char *OBJ_nid2ln(int n)
327         {
328         ADDED_OBJ ad,*adp;
329         ASN1_OBJECT ob;
330
331         if ((n >= 0) && (n < NUM_NID))
332                 {
333                 if ((n != NID_undef) && (nid_objs[n].nid == NID_undef))
334                         {
335                         OBJerr(OBJ_F_OBJ_NID2LN,OBJ_R_UNKNOWN_NID);
336                         return(NULL);
337                         }
338                 return(nid_objs[n].ln);
339                 }
340         else if (added == NULL)
341                 return(NULL);
342         else
343                 {
344                 ad.type=ADDED_NID;
345                 ad.obj= &ob;
346                 ob.nid=n;
347                 adp=(ADDED_OBJ *)lh_retrieve(added,&ad);
348                 if (adp != NULL)
349                         return(adp->obj->ln);
350                 else
351                         {
352                         OBJerr(OBJ_F_OBJ_NID2LN,OBJ_R_UNKNOWN_NID);
353                         return(NULL);
354                         }
355                 }
356         }
357
358 int OBJ_obj2nid(ASN1_OBJECT *a)
359         {
360         ASN1_OBJECT **op;
361         ADDED_OBJ ad,*adp;
362
363         if (a == NULL)
364                 return(NID_undef);
365         if (a->nid != 0)
366                 return(a->nid);
367
368         if (added != NULL)
369                 {
370                 ad.type=ADDED_DATA;
371                 ad.obj=a;
372                 adp=(ADDED_OBJ *)lh_retrieve(added,&ad);
373                 if (adp != NULL) return (adp->obj->nid);
374                 }
375         op=(ASN1_OBJECT **)OBJ_bsearch((char *)&a,(char *)obj_objs,NUM_OBJ,
376                 sizeof(ASN1_OBJECT *),obj_cmp);
377         if (op == NULL)
378                 return(NID_undef);
379         return((*op)->nid);
380         }
381
382 /* Convert an object name into an ASN1_OBJECT
383  * if "noname" is not set then search for short and long names first.
384  * This will convert the "dotted" form into an object: unlike OBJ_txt2nid
385  * it can be used with any objects, not just registered ones.
386  */
387
388 ASN1_OBJECT *OBJ_txt2obj(const char *s, int no_name)
389         {
390         int nid = NID_undef;
391         ASN1_OBJECT *op=NULL;
392         unsigned char *buf,*p;
393         int i, j;
394
395         if(!no_name) {
396                 if( ((nid = OBJ_sn2nid(s)) != NID_undef) ||
397                         ((nid = OBJ_ln2nid(s)) != NID_undef) ) 
398                                         return OBJ_nid2obj(nid);
399         }
400
401         /* Work out size of content octets */
402         i=a2d_ASN1_OBJECT(NULL,0,s,-1);
403         if (i <= 0) {
404                 /* Clear the error */
405                 ERR_get_error();
406                 return NULL;
407         }
408         /* Work out total size */
409         j = ASN1_object_size(0,i,V_ASN1_OBJECT);
410
411         if((buf=(unsigned char *)OPENSSL_malloc(j)) == NULL) return NULL;
412
413         p = buf;
414         /* Write out tag+length */
415         ASN1_put_object(&p,0,i,V_ASN1_OBJECT,V_ASN1_UNIVERSAL);
416         /* Write out contents */
417         a2d_ASN1_OBJECT(p,i,s,-1);
418         
419         p=buf;
420         op=d2i_ASN1_OBJECT(NULL,&p,i);
421         OPENSSL_free(buf);
422         return op;
423         }
424
425 int OBJ_obj2txt(char *buf, int buf_len, ASN1_OBJECT *a, int no_name)
426 {
427         int i,idx=0,n=0,len,nid;
428         unsigned long l;
429         unsigned char *p;
430         const char *s;
431         char tbuf[32];
432
433         if (buf_len <= 0) return(0);
434
435         if ((a == NULL) || (a->data == NULL)) {
436                 buf[0]='\0';
437                 return(0);
438         }
439
440         nid=OBJ_obj2nid(a);
441         if ((nid == NID_undef) || no_name) {
442                 len=a->length;
443                 p=a->data;
444
445                 idx=0;
446                 l=0;
447                 while (idx < a->length) {
448                         l|=(p[idx]&0x7f);
449                         if (!(p[idx] & 0x80)) break;
450                         l<<=7L;
451                         idx++;
452                 }
453                 idx++;
454                 i=(int)(l/40);
455                 if (i > 2) i=2;
456                 l-=(long)(i*40);
457
458                 sprintf(tbuf,"%d.%lu",i,l);
459                 i=strlen(tbuf);
460                 strncpy(buf,tbuf,buf_len);
461                 buf_len-=i;
462                 buf+=i;
463                 n+=i;
464
465                 l=0;
466                 for (; idx<len; idx++) {
467                         l|=p[idx]&0x7f;
468                         if (!(p[idx] & 0x80)) {
469                                 sprintf(tbuf,".%lu",l);
470                                 i=strlen(tbuf);
471                                 if (buf_len > 0)
472                                         strncpy(buf,tbuf,buf_len);
473                                 buf_len-=i;
474                                 buf+=i;
475                                 n+=i;
476                                 l=0;
477                         }
478                         l<<=7L;
479                 }
480         } else {
481                 s=OBJ_nid2ln(nid);
482                 if (s == NULL)
483                         s=OBJ_nid2sn(nid);
484                 strncpy(buf,s,buf_len);
485                 n=strlen(s);
486         }
487         buf[buf_len-1]='\0';
488         return(n);
489 }
490
491 int OBJ_txt2nid(char *s)
492 {
493         ASN1_OBJECT *obj;
494         int nid;
495         obj = OBJ_txt2obj(s, 0);
496         nid = OBJ_obj2nid(obj);
497         ASN1_OBJECT_free(obj);
498         return nid;
499 }
500
501 int OBJ_ln2nid(const char *s)
502         {
503         ASN1_OBJECT o,*oo= &o,**op;
504         ADDED_OBJ ad,*adp;
505
506         o.ln=s;
507         if (added != NULL)
508                 {
509                 ad.type=ADDED_LNAME;
510                 ad.obj= &o;
511                 adp=(ADDED_OBJ *)lh_retrieve(added,&ad);
512                 if (adp != NULL) return (adp->obj->nid);
513                 }
514         op=(ASN1_OBJECT **)OBJ_bsearch((char *)&oo,(char *)ln_objs,NUM_LN,
515                 sizeof(ASN1_OBJECT *),ln_cmp);
516         if (op == NULL) return(NID_undef);
517         return((*op)->nid);
518         }
519
520 int OBJ_sn2nid(const char *s)
521         {
522         ASN1_OBJECT o,*oo= &o,**op;
523         ADDED_OBJ ad,*adp;
524
525         o.sn=s;
526         if (added != NULL)
527                 {
528                 ad.type=ADDED_SNAME;
529                 ad.obj= &o;
530                 adp=(ADDED_OBJ *)lh_retrieve(added,&ad);
531                 if (adp != NULL) return (adp->obj->nid);
532                 }
533         op=(ASN1_OBJECT **)OBJ_bsearch((char *)&oo,(char *)sn_objs,NUM_SN,
534                 sizeof(ASN1_OBJECT *),sn_cmp);
535         if (op == NULL) return(NID_undef);
536         return((*op)->nid);
537         }
538
539 static int obj_cmp(const void *ap, const void *bp)
540         {
541         int j;
542         ASN1_OBJECT *a= *(ASN1_OBJECT **)ap;
543         ASN1_OBJECT *b= *(ASN1_OBJECT **)bp;
544
545         j=(a->length - b->length);
546         if (j) return(j);
547         return(memcmp(a->data,b->data,a->length));
548         }
549
550 char *OBJ_bsearch(char *key, char *base, int num, int size, int (*cmp)(const void *, const void *))
551         {
552         int l,h,i,c;
553         char *p;
554
555         if (num == 0) return(NULL);
556         l=0;
557         h=num;
558         while (l < h)
559                 {
560                 i=(l+h)/2;
561                 p= &(base[i*size]);
562                 c=(*cmp)(key,p);
563                 if (c < 0)
564                         h=i;
565                 else if (c > 0)
566                         l=i+1;
567                 else
568                         return(p);
569                 }
570 #ifdef CHARSET_EBCDIC
571 /* THIS IS A KLUDGE - Because the *_obj is sorted in ASCII order, and
572  * I don't have perl (yet), we revert to a *LINEAR* search
573  * when the object wasn't found in the binary search.
574  */
575         for (i=0; i<num; ++i) {
576                 p= &(base[i*size]);
577                 if ((*cmp)(key,p) == 0)
578                         return p;
579         }
580 #endif
581         return(NULL);
582         }
583
584 int OBJ_create_objects(BIO *in)
585         {
586         MS_STATIC char buf[512];
587         int i,num=0;
588         char *o,*s,*l=NULL;
589
590         for (;;)
591                 {
592                 s=o=NULL;
593                 i=BIO_gets(in,buf,512);
594                 if (i <= 0) return(num);
595                 buf[i-1]='\0';
596                 if (!isalnum((unsigned char)buf[0])) return(num);
597                 o=s=buf;
598                 while (isdigit((unsigned char)*s) || (*s == '.'))
599                         s++;
600                 if (*s != '\0')
601                         {
602                         *(s++)='\0';
603                         while (isspace((unsigned char)*s))
604                                 s++;
605                         if (*s == '\0')
606                                 s=NULL;
607                         else
608                                 {
609                                 l=s;
610                                 while ((*l != '\0') && !isspace((unsigned char)*l))
611                                         l++;
612                                 if (*l != '\0')
613                                         {
614                                         *(l++)='\0';
615                                         while (isspace((unsigned char)*l))
616                                                 l++;
617                                         if (*l == '\0') l=NULL;
618                                         }
619                                 else
620                                         l=NULL;
621                                 }
622                         }
623                 else
624                         s=NULL;
625                 if ((o == NULL) || (*o == '\0')) return(num);
626                 if (!OBJ_create(o,s,l)) return(num);
627                 num++;
628                 }
629         /* return(num); */
630         }
631
632 int OBJ_create(char *oid, char *sn, char *ln)
633         {
634         int ok=0;
635         ASN1_OBJECT *op=NULL;
636         unsigned char *buf;
637         int i;
638
639         i=a2d_ASN1_OBJECT(NULL,0,oid,-1);
640         if (i <= 0) return(0);
641
642         if ((buf=(unsigned char *)OPENSSL_malloc(i)) == NULL)
643                 {
644                 OBJerr(OBJ_F_OBJ_CREATE,OBJ_R_MALLOC_FAILURE);
645                 return(0);
646                 }
647         i=a2d_ASN1_OBJECT(buf,i,oid,-1);
648         op=(ASN1_OBJECT *)ASN1_OBJECT_create(OBJ_new_nid(1),buf,i,sn,ln);
649         if (op == NULL) 
650                 goto err;
651         ok=OBJ_add_object(op);
652 err:
653         ASN1_OBJECT_free(op);
654         OPENSSL_free(buf);
655         return(ok);
656         }
657