0d5ab6741f16b313eb48e2f519808ccd1d719be2
[openssl.git] / util / mkdef.pl
1 #!/usr/local/bin/perl -w
2 #
3 # generate a .def file
4 #
5 # It does this by parsing the header files and looking for the
6 # prototyped functions: it then prunes the output.
7 #
8
9 my $crypto_num="util/libeay.num";
10 my $ssl_num=   "util/ssleay.num";
11
12 my $do_update = 0;
13 my $do_crypto = 0;
14 my $do_ssl = 0;
15 my $do_ctest = 0;
16 my $do_ctestall = 0;
17 my $rsaref = 0;
18
19 my $W32=1;
20 my $NT=0;
21 # Set this to make typesafe STACK definitions appear in DEF
22 my $safe_stack_def = 0;
23
24 my $options="";
25 open(IN,"<Makefile.ssl") || die "unable to open Makefile.ssl!\n";
26 while(<IN>) {
27     $options=$1 if (/^OPTIONS=(.*)$/);
28 }
29 close(IN);
30
31 # The following ciphers may be excluded (by Configure). This means functions
32 # defined with ifndef(NO_XXX) are not included in the .def file, and everything
33 # in directory xxx is ignored.
34 my $no_rc2; my $no_rc4; my $no_rc5; my $no_idea; my $no_des; my $no_bf;
35 my $no_cast;
36 my $no_md2; my $no_md4; my $no_md5; my $no_sha; my $no_ripemd; my $no_mdc2;
37 my $no_rsa; my $no_dsa; my $no_dh; my $no_hmac=0;
38
39 foreach (@ARGV, split(/ /, $options))
40         {
41         $W32=1 if $_ eq "32";
42         $W32=0 if $_ eq "16";
43         if($_ eq "NT") {
44                 $W32 = 1;
45                 $NT = 1;
46         }
47         $do_ssl=1 if $_ eq "ssleay";
48         $do_ssl=1 if $_ eq "ssl";
49         $do_crypto=1 if $_ eq "libeay";
50         $do_crypto=1 if $_ eq "crypto";
51         $do_update=1 if $_ eq "update";
52         $do_ctest=1 if $_ eq "ctest";
53         $do_ctestall=1 if $_ eq "ctestall";
54         $rsaref=1 if $_ eq "rsaref";
55         #$safe_stack_def=1 if $_ eq "-DDEBUG_SAFESTACK";
56
57         if    (/^no-rc2$/)      { $no_rc2=1; }
58         elsif (/^no-rc4$/)      { $no_rc4=1; }
59         elsif (/^no-rc5$/)      { $no_rc5=1; }
60         elsif (/^no-idea$/)     { $no_idea=1; }
61         elsif (/^no-des$/)      { $no_des=1; }
62         elsif (/^no-bf$/)       { $no_bf=1; }
63         elsif (/^no-cast$/)     { $no_cast=1; }
64         elsif (/^no-md2$/)      { $no_md2=1; }
65         elsif (/^no-md4$/)      { $no_md4=1; }
66         elsif (/^no-md5$/)      { $no_md5=1; }
67         elsif (/^no-sha$/)      { $no_sha=1; }
68         elsif (/^no-ripemd$/)   { $no_ripemd=1; }
69         elsif (/^no-mdc2$/)     { $no_mdc2=1; }
70         elsif (/^no-rsa$/)      { $no_rsa=1; }
71         elsif (/^no-dsa$/)      { $no_dsa=1; }
72         elsif (/^no-dh$/)       { $no_dh=1; }
73         elsif (/^no-hmac$/)     { $no_hmac=1; }
74         }
75
76
77 if (!$do_ssl && !$do_crypto)
78         {
79         print STDERR "usage: $0 ( ssl | crypto ) [ 16 | 32 | NT ] [rsaref]\n";
80         exit(1);
81         }
82
83 %ssl_list=&load_numbers($ssl_num);
84 $max_ssl = $max_num;
85 %crypto_list=&load_numbers($crypto_num);
86 $max_crypto = $max_num;
87
88 my $ssl="ssl/ssl.h";
89
90 my $crypto ="crypto/crypto.h";
91 $crypto.=" crypto/des/des.h" unless $no_des;
92 $crypto.=" crypto/idea/idea.h" unless $no_idea;
93 $crypto.=" crypto/rc4/rc4.h" unless $no_rc4;
94 $crypto.=" crypto/rc5/rc5.h" unless $no_rc5;
95 $crypto.=" crypto/rc2/rc2.h" unless $no_rc2;
96 $crypto.=" crypto/bf/blowfish.h" unless $no_bf;
97 $crypto.=" crypto/cast/cast.h" unless $no_cast;
98 $crypto.=" crypto/md2/md2.h" unless $no_md2;
99 $crypto.=" crypto/md4/md4.h" unless $no_md4;
100 $crypto.=" crypto/md5/md5.h" unless $no_md5;
101 $crypto.=" crypto/mdc2/mdc2.h" unless $no_mdc2;
102 $crypto.=" crypto/sha/sha.h" unless $no_sha;
103 $crypto.=" crypto/ripemd/ripemd.h" unless $no_ripemd;
104
105 $crypto.=" crypto/bn/bn.h";
106 $crypto.=" crypto/rsa/rsa.h" unless $no_rsa;
107 $crypto.=" crypto/dsa/dsa.h" unless $no_dsa;
108 $crypto.=" crypto/dh/dh.h" unless $no_dh;
109 $crypto.=" crypto/hmac/hmac.h" unless $no_hmac;
110
111 $crypto.=" crypto/stack/stack.h";
112 $crypto.=" crypto/buffer/buffer.h";
113 $crypto.=" crypto/bio/bio.h";
114 $crypto.=" crypto/dso/dso.h";
115 $crypto.=" crypto/lhash/lhash.h";
116 $crypto.=" crypto/conf/conf.h";
117 $crypto.=" crypto/txt_db/txt_db.h";
118
119 $crypto.=" crypto/evp/evp.h";
120 $crypto.=" crypto/objects/objects.h";
121 $crypto.=" crypto/pem/pem.h";
122 #$crypto.=" crypto/meth/meth.h";
123 $crypto.=" crypto/asn1/asn1.h";
124 $crypto.=" crypto/asn1/asn1_mac.h";
125 $crypto.=" crypto/err/err.h";
126 $crypto.=" crypto/pkcs7/pkcs7.h";
127 $crypto.=" crypto/pkcs12/pkcs12.h";
128 $crypto.=" crypto/x509/x509.h";
129 $crypto.=" crypto/x509/x509_vfy.h";
130 $crypto.=" crypto/x509v3/x509v3.h";
131 $crypto.=" crypto/rand/rand.h";
132 $crypto.=" crypto/comp/comp.h";
133 $crypto.=" crypto/tmdiff.h";
134
135 my @ssl_func = &do_defs("SSLEAY", $ssl);
136 my @crypto_func = &do_defs("LIBEAY", $crypto);
137
138
139 if ($do_update) {
140
141 if ($do_ssl == 1) {
142         open(OUT, ">>$ssl_num");
143         &update_numbers(*OUT,"SSLEAY",*ssl_list,$max_ssl, @ssl_func);
144         close OUT;
145 }
146
147 if($do_crypto == 1) {
148         open(OUT, ">>$crypto_num");
149         &update_numbers(*OUT,"LIBEAY",*crypto_list,$max_crypto, @crypto_func);
150         close OUT;
151
152
153 } elsif ($do_ctest || $do_ctestall) {
154
155         print <<"EOF";
156
157 /* Test file to check all DEF file symbols are present by trying
158  * to link to all of them. This is *not* intended to be run!
159  */
160
161 int main()
162 {
163 EOF
164         &print_test_file(*STDOUT,"SSLEAY",*ssl_list,$do_ctestall,@ssl_func)
165                 if $do_ssl == 1;
166
167         &print_test_file(*STDOUT,"LIBEAY",*crypto_list,$do_ctestall,@crypto_func)
168                 if $do_crypto == 1;
169
170         print "}\n";
171
172 } else {
173
174         &print_def_file(*STDOUT,"SSLEAY",*ssl_list,@ssl_func)
175                 if $do_ssl == 1;
176
177         &print_def_file(*STDOUT,"LIBEAY",*crypto_list,@crypto_func)
178                 if $do_crypto == 1;
179
180 }
181
182
183 sub do_defs
184 {
185         my($name,$files)=@_;
186         my $file;
187         my @ret;
188         my %funcs;
189         my $cpp;
190
191         foreach $file (split(/\s+/,$files))
192                 {
193                 open(IN,"<$file") || die "unable to open $file:$!\n";
194                 my $line = "", my $def= "";
195                 my %tag = (
196                         FreeBSD         => 0,
197                         NOPROTO         => 0,
198                         WIN16           => 0,
199                         PERL5           => 0,
200                         _WINDLL         => 0,
201                         NO_FP_API       => 0,
202                         CONST_STRICT    => 0,
203                         TRUE            => 1,
204                         NO_RC2          => 0,
205                         NO_RC4          => 0,
206                         NO_RC5          => 0,
207                         NO_IDEA         => 0,
208                         NO_DES          => 0,
209                         NO_BF           => 0,
210                         NO_CAST         => 0,
211                         NO_MD2          => 0,
212                         NO_MD4          => 0,
213                         NO_MD5          => 0,
214                         NO_SHA          => 0,
215                         NO_RIPEMD       => 0,
216                         NO_MDC2         => 0,
217                         NO_RSA          => 0,
218                         NO_DSA          => 0,
219                         NO_DH           => 0,
220                         NO_HMAC         => 0,
221                 );
222                 while(<IN>) {
223                         last if (/BEGIN ERROR CODES/);
224                         if ($line ne '') {
225                                 $_ = $line . $_;
226                                 $line = '';
227                         }
228
229                         if (/\\$/) {
230                                 $line = $_;
231                                 next;
232                         }
233
234                         $cpp = 1 if /^#.*ifdef.*cplusplus/;
235                         if ($cpp) {
236                                 $cpp = 0 if /^#.*endif/;
237                                 next;
238                         }
239
240                         s/\/\*.*?\*\///gs;                   # ignore comments
241                         s/{[^{}]*}//gs;                      # ignore {} blocks
242                         if (/^\#\s*ifndef (.*)/) {
243                                 push(@tag,$1);
244                                 $tag{$1}=-1;
245                                 next;
246                         } elsif (/^\#\s*if !defined\(([^\)]+)\)/) {
247                                 push(@tag,$1);
248                                 $tag{$1}=-1;
249                                 next;
250                         } elsif (/^\#\s*ifdef (.*)/) {
251                                 push(@tag,$1);
252                                 $tag{$1}=1;
253                                 next;
254                         } elsif (/^\#\s*if defined(.*)/) {
255                                 push(@tag,$1);
256                                 $tag{$1}=1;
257                                 next;
258                         } elsif (/^\#\s*endif/) {
259                                 $tag{$tag[$#tag]}=0;
260                                 pop(@tag);
261                                 next;
262                         } elsif (/^\#\s*else/) {
263                                 my $t=$tag[$#tag];
264                                 $tag{$t}= -$tag{$t};
265                                 next;
266                         } elsif (/^\#\s*if\s+1/) {
267                                 # Dummy tag
268                                 push(@tag,"TRUE");
269                                 $tag{"TRUE"}=1;
270                                 next;
271                         } elsif (/^\#\s*if\s+0/) {
272                                 # Dummy tag
273                                 push(@tag,"TRUE");
274                                 $tag{"TRUE"}=-1;
275                                 next;
276                         } elsif (/^\#/) {
277                                 next;
278                         }
279                         if (/^\s*DECLARE_STACK_OF\s*\(\s*(\w*)\s*\)/) {
280                                 next;
281                         } elsif (/^\s*DECLARE_ASN1_SET_OF\s*\(\s*(\w*)\s*\)/) {
282                                 next;
283                         } elsif (/^DECLARE_PEM_rw\s*\(\s*(\w*)\s*,/ ||
284                                      /^DECLARE_PEM_rw_cb\s*\(\s*(\w*)\s*,/ ) {
285                                 if (!($no_rsa && ($1 eq "RSAPrivateKey" ||
286                                                   $1 eq "RSAPublicKey" ||
287                                                   $1 eq "RSA_PUBKEY"))) {
288                                         if($W32) {
289                                                 $funcs{"PEM_read_${1}"} = 1;
290                                                 $funcs{"PEM_write_${1}"} = 1;
291                                         }
292                                         $funcs{"PEM_read_bio_${1}"} = 1;
293                                         $funcs{"PEM_write_bio_${1}"} = 1;
294                                 }
295                         } elsif (/^DECLARE_PEM_write\s*\(\s*(\w*)\s*,/ ||
296                                      /^DECLARE_PEM_write_cb\s*\(\s*(\w*)\s*,/ ) {
297                                 if (!($no_rsa && ($1 eq "RSAPrivateKey" ||
298                                                   $1 eq "RSAPublicKey" ||
299                                                   $1 eq "RSA_PUBKEY"))) {
300                                         if($W32) {
301                                                 $funcs{"PEM_write_${1}"} = 1;
302                                         }
303                                         $funcs{"PEM_write_bio_${1}"} = 1;
304                                 }
305                         } elsif (/^DECLARE_PEM_read\s*\(\s*(\w*)\s*,/ ||
306                                      /^DECLARE_PEM_read_cb\s*\(\s*(\w*)\s*,/ ) {
307                                 if($W32) {
308                                         $funcs{"PEM_read_${1}"} = 1;
309                                 }
310                                 $funcs{"PEM_read_bio_${1}"} = 1;
311                         } elsif (
312                                 ($tag{'TRUE'} != -1) &&
313                                 ($tag{'FreeBSD'} != 1) &&
314                                 ($tag{'CONST_STRICT'} != 1) &&
315                                 (($W32 && ($tag{'WIN16'} != 1)) ||
316                                  (!$W32 && ($tag{'WIN16'} != -1))) &&
317                                 ($tag{'PERL5'} != 1) &&
318 #                               ($tag{'_WINDLL'} != -1) &&
319                                 ((!$W32 && $tag{'_WINDLL'} != -1) ||
320                                  ($W32 && $tag{'_WINDLL'} != 1)) &&
321                                 ((($tag{'NO_FP_API'} != 1) && $W32) ||
322                                  (($tag{'NO_FP_API'} != -1) && !$W32)) &&
323                                 ($tag{'NO_RC2'} == 0  || !$no_rc2) &&
324                                 ($tag{'NO_RC4'} == 0  || !$no_rc4) &&
325                                 ($tag{'NO_RC5'} == 0  || !$no_rc5) &&
326                                 ($tag{'NO_IDEA'} == 0 || !$no_idea) &&
327                                 ($tag{'NO_DES'} == 0  || !$no_des) &&
328                                 ($tag{'NO_BF'} == 0   || !$no_bf) &&
329                                 ($tag{'NO_CAST'} == 0 || !$no_cast) &&
330                                 ($tag{'NO_MD2'} == 0  || !$no_md2) &&
331                                 ($tag{'NO_MD4'} == 0  || !$no_md4) &&
332                                 ($tag{'NO_MD5'} == 0  || !$no_md5) &&
333                                 ($tag{'NO_SHA'} == 0  || !$no_sha) &&
334                                 ($tag{'NO_RIPEMD'} == 0 || !$no_ripemd) &&
335                                 ($tag{'NO_MDC2'} == 0 || !$no_mdc2) &&
336                                 ($tag{'NO_RSA'} == 0  || !$no_rsa) &&
337                                 ($tag{'NO_DSA'} == 0  || !$no_dsa) &&
338                                 ($tag{'NO_DH'} == 0   || !$no_dh) &&
339                                 ($tag{'NO_HMAC'} == 0 || !$no_hmac))
340                                 {
341                                         if (/{|\/\*/) { # }
342                                                 $line = $_;
343                                         } else {
344                                                 $def .= $_;
345                                         }
346                                 }
347                         }
348                 close(IN);
349
350                 foreach (split /;/, $def) {
351                         s/^[\n\s]*//g;
352                         s/[\n\s]*$//g;
353                         next if(/#define/);
354                         next if(/typedef\W/);
355                         next if(/EVP_bf/ and $no_bf);
356                         next if(/EVP_cast/ and $no_cast);
357                         next if(/EVP_des/ and $no_des);
358                         next if(/EVP_dss/ and $no_dsa);
359                         next if(/EVP_idea/ and $no_idea);
360                         next if(/EVP_md2/ and $no_md2);
361                         next if(/EVP_md4/ and $no_md4);
362                         next if(/EVP_md5/ and $no_md5);
363                         next if(/EVP_rc2/ and $no_rc2);
364                         next if(/EVP_rc4/ and $no_rc4);
365                         next if(/EVP_rc5/ and $no_rc5);
366                         next if(/EVP_ripemd/ and $no_ripemd);
367                         next if(/EVP_sha/ and $no_sha);
368                         next if(/EVP_(Open|Seal)(Final|Init)/ and $no_rsa);
369                         next if(/PEM_Seal(Final|Init|Update)/ and $no_rsa);
370                         next if(/RSAPrivateKey/ and $no_rsa);
371                         next if(/SSLv23?_((client|server)_)?method/ and $no_rsa);
372
373                         if (/\(\*(\w*)\([^\)]+/) {
374                                 $funcs{$1} = 1;
375                         } elsif (/\w+\W+(\w+)\W*\(\s*\)$/s) {
376                                 # K&R C
377                                 next;
378                         } elsif (/\w+\W+\w+\W*\(.*\)$/s) {
379                                 while (not /\(\)$/s) {
380                                         s/[^\(\)]*\)$/\)/s;
381                                         s/\([^\(\)]*\)\)$/\)/s;
382                                 }
383                                 s/\(void\)//;
384                                 /(\w+)\W*\(\)/s;
385                                 $funcs{$1} = 1;
386                         } elsif (/\(/ and not (/=/)) {
387                                 print STDERR "File $file: cannot parse: $_;\n";
388                         }
389                 }
390         }
391
392         # Prune the returned functions
393
394         delete $funcs{"SSL_add_dir_cert_subjects_to_stack"};
395         delete $funcs{"RSA_PKCS1_RSAref"} unless $rsaref;
396         delete $funcs{"bn_dump1"};
397
398         if($W32) {
399                 delete $funcs{"BIO_s_file_internal"};
400                 delete $funcs{"BIO_new_file_internal"};
401                 delete $funcs{"BIO_new_fp_internal"};
402         } else {
403                 if(exists $funcs{"ERR_load_CRYPTO_strings"}) {
404                         delete $funcs{"ERR_load_CRYPTO_strings"};
405                         $funcs{"ERR_load_CRYPTOlib_strings"} = 1;
406                 }
407                 delete $funcs{"BIO_s_file"};
408                 delete $funcs{"BIO_new_file"};
409                 delete $funcs{"BIO_new_fp"};
410         }
411         if (!$NT) {
412                 delete $funcs{"BIO_s_log"};
413         }
414
415         push @ret, keys %funcs;
416
417         return(@ret);
418 }
419
420 sub print_test_file
421 {
422         (*OUT,my $name,*nums,my $all,my @functions)=@_;
423         my $n = 1; my @e; my @r;
424         my $func; my $prev = "";
425
426         push(@functions, keys %nums) if $all;
427         (@e)=grep(/^SSLeay/,@functions);
428         (@r)=grep(!/^SSLeay/,@functions);
429         @functions=((sort @e),(sort @r));
430
431         foreach $func (@functions) {
432                 if ($func ne $prev) {
433                         if (!defined($nums{$func})) {
434                                 printf STDERR "$func does not have a number assigned\n"
435                                     if(!$do_update);
436                         } else {
437                                 $n=$nums{$func};
438                                 print OUT "\t$func();\n";
439                         }
440                 }
441                 $prev = $func;  # To avoid duplicates...
442         }
443 }
444
445 sub print_def_file
446 {
447         (*OUT,my $name,*nums,my @functions)=@_;
448         my $n = 1; my @e; my @r;
449
450         if ($W32)
451                 { $name.="32"; }
452         else
453                 { $name.="16"; }
454
455         print OUT <<"EOF";
456 ;
457 ; Definition file for the DLL version of the $name library from OpenSSL
458 ;
459
460 LIBRARY         $name
461
462 DESCRIPTION     'OpenSSL $name - http://www.openssl.org/'
463
464 EOF
465
466         if (!$W32) {
467                 print <<"EOF";
468 CODE            PRELOAD MOVEABLE
469 DATA            PRELOAD MOVEABLE SINGLE
470
471 EXETYPE         WINDOWS
472
473 HEAPSIZE        4096
474 STACKSIZE       8192
475
476 EOF
477         }
478
479         print "EXPORTS\n";
480
481
482         (@e)=grep(/^SSLeay/,@functions);
483         (@r)=grep(!/^SSLeay/,@functions);
484         @functions=((sort @e),(sort @r));
485
486         foreach $func (@functions) {
487                 if (!defined($nums{$func})) {
488                         printf STDERR "$func does not have a number assigned\n"
489                                         if(!$do_update);
490                 } else {
491                         $n=$nums{$func};
492                         printf OUT "    %s%-40s@%d\n",($W32)?"":"_",$func,$n;
493                 }
494         }
495         printf OUT "\n";
496 }
497
498 sub load_numbers
499 {
500         my($name)=@_;
501         my(@a,%ret);
502
503         $max_num = 0;
504
505         open(IN,"<$name") || die "unable to open $name:$!\n";
506         while (<IN>) {
507                 chop;
508                 s/#.*$//;
509                 next if /^\s*$/;
510                 @a=split;
511                 $ret{$a[0]}=$a[1];
512                 $max_num = $a[1] if $a[1] > $max_num;
513         }
514         close(IN);
515         return(%ret);
516 }
517
518 sub update_numbers
519 {
520         (*OUT,$name,*nums,my $start_num, my @functions)=@_;
521         my $new_funcs = 0;
522         print STDERR "Updating $name\n";
523         foreach $func (@functions) {
524                 if (!exists $nums{$func}) {
525                         $new_funcs++;
526                         printf OUT "%s%-40s%d\n","",$func, ++$start_num;
527                 }
528         }
529         if($new_funcs) {
530                 print STDERR "$new_funcs New Functions added\n";
531         } else {
532                 print STDERR "No New Functions Added\n";
533         }
534 }