Add functions for getting/setting SNI/ALPN info in SSL_SESSION
[openssl.git] / util / find-doc-nits
1 #! /usr/bin/env perl
2 # Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
3 #
4 # Licensed under the OpenSSL license (the "License").  You may not use
5 # this file except in compliance with the License.  You can obtain a copy
6 # in the file LICENSE in the source distribution or at
7 # https://www.openssl.org/source/license.html
8
9
10 require 5.10.0;
11 use warnings;
12 use strict;
13 use Pod::Checker;
14 use File::Find;
15 use File::Basename;
16 use File::Spec::Functions;
17 use Getopt::Std;
18 use lib catdir(dirname($0), "perl");
19 use OpenSSL::Util::Pod;
20
21 # Options.
22 our($opt_d);
23 our($opt_h);
24 our($opt_l);
25 our($opt_n);
26 our($opt_p);
27 our($opt_s);
28 our($opt_u);
29 our($opt_c);
30
31 sub help()
32 {
33     print <<EOF;
34 Find small errors (nits) in documentation.  Options:
35     -d Detailed list of undocumented (implies -u)
36     -l Print bogus links
37     -n Print nits in POD pages
38     -s Also print missing sections in POD pages (implies -n)
39     -p Warn if non-public name documented (implies -n)
40     -u List undocumented functions
41     -h Print this help message
42     -c List undocumented commands and options
43 EOF
44     exit;
45 }
46
47 my $temp = '/tmp/docnits.txt';
48 my $OUT;
49 my %public;
50
51 my %mandatory_sections =
52     ( '*'    => [ 'NAME', 'DESCRIPTION', 'COPYRIGHT' ],
53       1      => [ 'SYNOPSIS', 'OPTIONS' ],
54       3      => [ 'SYNOPSIS', 'RETURN VALUES' ],
55       5      => [ ],
56       7      => [ ] );
57
58 # Cross-check functions in the NAME and SYNOPSIS section.
59 sub name_synopsis()
60 {
61     my $id = shift;
62     my $filename = shift;
63     my $contents = shift;
64
65     # Get NAME section and all words in it.
66     return unless $contents =~ /=head1 NAME(.*)=head1 SYNOPSIS/ms;
67     my $tmp = $1;
68     $tmp =~ tr/\n/ /;
69     print "$id trailing comma before - in NAME\n" if $tmp =~ /, *-/;
70     $tmp =~ s/ -.*//g;
71     $tmp =~ s/  */ /g;
72     print "$id missing comma in NAME\n" if $tmp =~ /[^,] /;
73     $tmp =~ s/,//g;
74
75     my $dirname = dirname($filename);
76     my $simplename = basename($filename);
77     $simplename =~ s/.pod$//;
78     my $foundfilename = 0;
79     my %foundfilenames = ();
80     my %names;
81     foreach my $n ( split ' ', $tmp ) {
82         $names{$n} = 1;
83         $foundfilename++ if $n eq $simplename;
84         $foundfilenames{$n} = 1
85             if -f "$dirname/$n.pod" && $n ne $simplename;
86     }
87     print "$id the following exist as other .pod files:\n",
88         join(" ", sort keys %foundfilenames), "\n"
89         if %foundfilenames;
90     print "$id $simplename (filename) missing from NAME section\n"
91         unless $foundfilename;
92     foreach my $n ( keys %names ) {
93         print "$id $n is not public\n"
94             if $opt_p and !defined $public{$n};
95     }
96
97     # Find all functions in SYNOPSIS
98     return unless $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms;
99     my $syn = $1;
100     foreach my $line ( split /\n+/, $syn ) {
101         my $sym;
102         $line =~ s/STACK_OF\([^)]+\)/int/g;
103         $line =~ s/__declspec\([^)]+\)//;
104         if ( $line =~ /env (\S*)=/ ) {
105             # environment variable env NAME=...
106             $sym = $1;
107         } elsif ( $line =~ /typedef.*\(\*(\S+)\)\(.*/ ) {
108             # a callback function: typedef ... (*NAME)(...
109             $sym = $1;
110         } elsif ( $line =~ /typedef.* (\S+);/ ) {
111             # a simple typedef: typedef ... NAME;
112             $sym = $1;
113         } elsif ( $line =~ /enum (\S*) \{/ ) {
114             # an enumeration: enum ... {
115             $sym = $1;
116         } elsif ( $line =~ /#define ([A-Za-z0-9_]+)/ ) {
117             $sym = $1;
118         } elsif ( $line =~ /([A-Za-z0-9_]+)\(/ ) {
119             $sym = $1;
120         }
121         else {
122             next;
123         }
124         print "$id $sym missing from NAME section\n"
125             unless defined $names{$sym};
126         $names{$sym} = 2;
127
128         # Do some sanity checks on the prototype.
129         print "$id prototype missing spaces around commas: $line\n"
130             if ( $line =~ /[a-z0-9],[^ ]/ );
131     }
132
133     foreach my $n ( keys %names ) {
134         next if $names{$n} == 2;
135         print "$id $n missing from SYNOPSIS\n";
136     }
137 }
138
139 sub check()
140 {
141     my $filename = shift;
142     my $dirname = basename(dirname($filename));
143
144     my $contents = '';
145     {
146         local $/ = undef;
147         open POD, $filename or die "Couldn't open $filename, $!";
148         $contents = <POD>;
149         close POD;
150     }
151
152     my $id = "${filename}:1:";
153
154     &name_synopsis($id, $filename, $contents)
155         unless $contents =~ /=for comment generic/
156             or $filename =~ m@man[157]/@;
157
158     print "$id doesn't start with =pod\n"
159         if $contents !~ /^=pod/;
160     print "$id doesn't end with =cut\n"
161         if $contents !~ /=cut\n$/;
162     print "$id more than one cut line.\n"
163         if $contents =~ /=cut.*=cut/ms;
164     print "$id missing copyright\n"
165         if $contents !~ /Copyright .* The OpenSSL Project Authors/;
166     print "$id copyright not last\n"
167         if $contents =~ /head1 COPYRIGHT.*=head/ms;
168     print "$id head2 in All uppercase\n"
169         if $contents =~ /head2\s+[A-Z ]+\n/;
170     print "$id extra space after head\n"
171         if $contents =~ /=head\d\s\s+/;
172     print "$id period in NAME section\n"
173         if $contents =~ /=head1 NAME.*\.\n.*=head1 SYNOPSIS/ms;
174     print "$id POD markup in NAME section\n"
175         if $contents =~ /=head1 NAME.*[<>].*=head1 SYNOPSIS/ms;
176     print "$id Duplicate $1 in L<>\n"
177         if $contents =~ /L<([^>]*)\|([^>]*)>/ && $1 eq $2;
178     print "$id Bad =over $1\n"
179         if $contents =~ /=over([^ ][^24])/;
180     print "$id Possible version style issue\n"
181         if $contents =~ /OpenSSL version [019]/;
182
183     if ( $contents !~ /=for comment multiple includes/ ) {
184         # Look for multiple consecutive openssl #include lines
185         # (non-consecutive lines are okay; see man3/MD5.pod).
186         if ( $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms ) {
187             my $count = 0;
188             foreach my $line ( split /\n+/, $1 ) {
189                 if ( $line =~ m@include <openssl/@ ) {
190                     print "$id has multiple includes\n" if ++$count == 2;
191                 } else {
192                     $count = 0;
193                 }
194             }
195         }
196     }
197
198     open my $OUT, '>', $temp
199         or die "Can't open $temp, $!";
200     podchecker($filename, $OUT);
201     close $OUT;
202     open $OUT, '<', $temp
203         or die "Can't read $temp, $!";
204     while ( <$OUT> ) {
205         next if /\(section\) in.*deprecated/;
206         print;
207     }
208     close $OUT;
209     unlink $temp || warn "Can't remove $temp, $!";
210
211     # Find what section this page is in; assume 3.
212     my $section = 3;
213     $section = $1 if $dirname =~ /man([1-9])/;
214
215     foreach ((@{$mandatory_sections{'*'}}, @{$mandatory_sections{$section}})) {
216         # Skip "return values" if not -s
217         next if $_ eq 'RETURN VALUES' and not $opt_s;
218         print "$id: missing $_ head1 section\n"
219             if $contents !~ /^=head1\s+${_}\s*$/m;
220     }
221 }
222
223 my %dups;
224
225 sub parsenum()
226 {
227     my $file = shift;
228     my @apis;
229
230     open my $IN, '<', $file
231         or die "Can't open $file, $!, stopped";
232
233     while ( <$IN> ) {
234         next if /^#/;
235         next if /\bNOEXIST\b/;
236         next if /\bEXPORT_VAR_AS_FUNC\b/;
237         my @fields = split();
238         die "Malformed line $_"
239             if scalar @fields != 2 && scalar @fields != 4;
240         push @apis, $fields[0];
241     }
242
243     close $IN;
244
245     print "# Found ", scalar(@apis), " in $file\n" unless $opt_p;
246     return sort @apis;
247 }
248
249 sub getdocced()
250 {
251     my $dir = shift;
252     my %return;
253
254     foreach my $pod ( glob("$dir/*.pod") ) {
255         my %podinfo = extract_pod_info($pod);
256         foreach my $n ( @{$podinfo{names}} ) {
257             $return{$n} = $pod;
258             print "# Duplicate $n in $pod and $dups{$n}\n"
259                 if defined $dups{$n} && $dups{$n} ne $pod;
260             $dups{$n} = $pod;
261         }
262     }
263
264     return %return;
265 }
266
267 my %docced;
268
269 sub checkmacros()
270 {
271     my $count = 0;
272
273     print "# Checking macros (approximate)\n";
274     foreach my $f ( glob('include/openssl/*.h') ) {
275         # Skip some internals we don't want to document yet.
276         next if $f eq 'include/openssl/asn1.h';
277         next if $f eq 'include/openssl/asn1t.h';
278         next if $f eq 'include/openssl/err.h';
279         open(IN, $f) || die "Can't open $f, $!";
280         while ( <IN> ) {
281             next unless /^#\s*define\s*(\S+)\(/;
282             my $macro = $1;
283             next if $docced{$macro};
284             next if $macro =~ /i2d_/
285                 || $macro =~ /d2i_/
286                 || $macro =~ /DEPRECATEDIN/
287                 || $macro =~ /IMPLEMENT_/
288                 || $macro =~ /DECLARE_/;
289             print "$f:$macro\n" if $opt_d;
290             $count++;
291         }
292         close(IN);
293     }
294     print "# Found $count macros missing (not all should be documented)\n"
295 }
296
297 sub printem()
298 {
299     my $libname = shift;
300     my $numfile = shift;
301     my $count = 0;
302
303     foreach my $func ( &parsenum($numfile) ) {
304         next if $docced{$func};
305
306         # Skip ASN1 utilities
307         next if $func =~ /^ASN1_/;
308
309         print "$libname:$func\n" if $opt_d;
310         $count++;
311     }
312     print "# Found $count missing from $numfile\n\n";
313 }
314
315
316 # Collection of links in each POD file.
317 # filename => [ "foo(1)", "bar(3)", ... ]
318 my %link_collection = ();
319 # Collection of names in each POD file.
320 # "name(s)" => filename
321 my %name_collection = ();
322
323 sub collectnames {
324     my $filename = shift;
325     $filename =~ m|man(\d)/|;
326     my $section = $1;
327     my $simplename = basename($filename, ".pod");
328     my $id = "${filename}:1:";
329
330     my $contents = '';
331     {
332         local $/ = undef;
333         open POD, $filename or die "Couldn't open $filename, $!";
334         $contents = <POD>;
335         close POD;
336     }
337
338     $contents =~ /=head1 NAME([^=]*)=head1 /ms;
339     my $tmp = $1;
340     unless (defined $tmp) {
341         print "$id weird name section\n";
342         return;
343     }
344     $tmp =~ tr/\n/ /;
345     $tmp =~ s/-.*//g;
346
347     my @names = map { s/\s+//g; $_ } split(/,/, $tmp);
348     unless (grep { $simplename eq $_ } @names) {
349         print "$id missing $simplename\n";
350         push @names, $simplename;
351     }
352     foreach my $name (@names) {
353         next if $name eq "";
354         my $name_sec = "$name($section)";
355         if (! exists $name_collection{$name_sec}) {
356             $name_collection{$name_sec} = $filename;
357         } else { #elsif ($filename ne $name_collection{$name_sec}) {
358             print "$id $name_sec also in $name_collection{$name_sec}\n";
359         }
360     }
361
362     my @foreign_names =
363         map { map { s/\s+//g; $_ } split(/,/, $_) }
364         $contents =~ /=for\s+comment\s+foreign\s+manuals:\s*(.*)\n\n/;
365     foreach (@foreign_names) {
366         $name_collection{$_} = undef; # It still exists!
367     }
368
369     my @links = $contents =~ /L<
370                               # if the link is of the form L<something|name(s)>,
371                               # then remove 'something'.  Note that 'something'
372                               # may contain POD codes as well...
373                               (?:(?:[^\|]|<[^>]*>)*\|)?
374                               # we're only interested in referenses that have
375                               # a one digit section number
376                               ([^\/>\(]+\(\d\))
377                              /gx;
378     $link_collection{$filename} = [ @links ];
379 }
380
381 sub checklinks {
382     foreach my $filename (sort keys %link_collection) {
383         foreach my $link (@{$link_collection{$filename}}) {
384             print "${filename}:1: reference to non-existing $link\n"
385                 unless exists $name_collection{$link};
386         }
387     }
388 }
389
390 sub publicize() {
391     foreach my $name ( &parsenum('util/libcrypto.num') ) {
392         $public{$name} = 1;
393     }
394     foreach my $name ( &parsenum('util/libssl.num') ) {
395         $public{$name} = 1;
396     }
397     foreach my $name ( &parsenum('util/private.num') ) {
398         $public{$name} = 1;
399     }
400 }
401
402 my %skips = (
403     'aes128' => 1,
404     'aes192' => 1,
405     'aes256' => 1,
406     'aria128' => 1,
407     'aria192' => 1,
408     'aria256' => 1,
409     'camellia128' => 1,
410     'camellia192' => 1,
411     'camellia256' => 1,
412     'des' => 1,
413     'des3' => 1,
414     'idea' => 1,
415     '[cipher]' => 1,
416     '[digest]' => 1,
417 );
418
419 sub checkflags() {
420     my $cmd = shift;
421     my %cmdopts;
422     my %docopts;
423     my $ok = 1;
424
425     # Get the list of options in the command.
426     open CFH, "./apps/openssl list --options $cmd|"
427         || die "Can list options for $cmd, $!";
428     while ( <CFH> ) {
429         chop;
430         s/ .$//;
431         $cmdopts{$_} = 1;
432     }
433     close CFH;
434
435     # Get the list of flags from the synopsis
436     open CFH, "<doc/man1/$cmd.pod"
437         || die "Can't open $cmd.pod, $!";
438     while ( <CFH> ) {
439         chop;
440         last if /DESCRIPTION/;
441         next unless /\[B<-([^ >]+)/;
442         $docopts{$1} = 1;
443     }
444     close CFH;
445
446     # See what's in the command not the manpage.
447     my @undocced = ();
448     foreach my $k ( keys %cmdopts ) {
449         push @undocced, $k unless $docopts{$k};
450     }
451     if ( scalar @undocced > 0 ) {
452         $ok = 0;
453         foreach ( @undocced ) {
454             print "doc/man1/$cmd.pod: Missing -$_\n";
455         }
456     }
457
458     # See what's in the command not the manpage.
459     my @unimpl = ();
460     foreach my $k ( keys %docopts ) {
461         push @unimpl, $k unless $cmdopts{$k};
462     }
463     if ( scalar @unimpl > 0 ) {
464         $ok = 0;
465         foreach ( @unimpl ) {
466             next if defined $skips{$_};
467             print "doc/man1/$cmd.pod: Not implemented -$_\n";
468         }
469     }
470
471     return $ok;
472 }
473
474 getopts('cdlnsphu');
475
476 &help() if $opt_h;
477 $opt_n = 1 if $opt_s or $opt_p;
478 $opt_u = 1 if $opt_d;
479
480 die "Need one of -[cdlnspu] flags.\n"
481     unless $opt_c or $opt_l or $opt_n or $opt_u;
482
483 if ( $opt_c ) {
484     my $ok = 1;
485     my @commands = ();
486
487     # Get list of commands.
488     open FH, "./apps/openssl list -1 -commands|"
489         || die "Can't list commands, $!";
490     while ( <FH> ) {
491         chop;
492         push @commands, $_;
493     }
494     close FH;
495
496     # See if each has a manpage.
497     foreach ( @commands ) {
498         next if $_ eq 'help' || $_ eq 'exit';
499         if ( ! -f "doc/man1/$_.pod" ) {
500             print "doc/man1/$_.pod does not exist\n";
501             $ok = 0;
502         } else {
503             $ok = 0 if not &checkflags($_);
504         }
505     }
506
507     # See what help is missing.
508     open FH, "./apps/openssl list --missing-help |"
509         || die "Can't list missing help, $!";
510     while ( <FH> ) {
511         chop;
512         my ($cmd, $flag) = split;
513         print "$cmd has no help for -$flag\n";
514         $ok = 0;
515     }
516     close FH;
517
518     exit 1 if not $ok;
519 }
520
521 if ( $opt_l ) {
522     foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
523         collectnames($_);
524     }
525     checklinks();
526 }
527
528 if ( $opt_n ) {
529     &publicize() if $opt_p;
530     foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
531         &check($_);
532     }
533 }
534
535 if ( $opt_u ) {
536     my %temp = &getdocced('doc/man3');
537     foreach ( keys %temp ) {
538         $docced{$_} = $temp{$_};
539     }
540     &printem('crypto', 'util/libcrypto.num');
541     &printem('ssl', 'util/libssl.num');
542     &checkmacros();
543 }
544
545 exit;