Sync architecture specific hardening support with dpkg 1.20.5
[blhc/blhc.git] / bin / blhc
1 #!/usr/bin/perl
2
3 # Build log hardening check, checks build logs for missing hardening flags.
4
5 # Copyright (C) 2012-2020  Simon Ruderich
6 #
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 # GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License
18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
20
21 use strict;
22 use warnings;
23
24 use Getopt::Long ();
25 use Text::ParseWords ();
26
27 our $VERSION = '0.11';
28
29
30 # CONSTANTS/VARIABLES
31
32 # Regex to catch compiler commands.
33 my $cc_regex = qr/
34     (?<!\s-)               # ignore options, e.g. "-c++" [sic!] (used by swig)
35     (?<!\.)                # ignore file names, e.g. "test.gcc"
36     (?:cc|gcc|g\+\+|c\+\+|gfortran|mpicc|mpicxx|mpifort)
37     (?:-[\d.]+)?           # version suffix, e.g. "gcc-4.6"
38     /x;
39 # Full regex which matches the complete compiler name. Used in a few places to
40 # prevent false negatives.
41 my $cc_regex_full_prefix = qr/
42     [a-z0-9_]+-(?:linux-|kfreebsd-)?gnu(?:eabi|eabihf)?
43     /x;
44 my $cc_regex_full = qr/
45     (?:$cc_regex_full_prefix-)?
46     $cc_regex
47     /x;
48 # Regex to check if a line contains a compiler command.
49 my $cc_regex_normal = qr/
50     \b$cc_regex(?:\s|\\)
51     /x;
52 # Regex to catch (GCC) compiler warnings.
53 my $warning_regex = qr/^(.+?):(\d+):\d+: warning: (.+?) \[(.+?)\]$/;
54 # Regex to catch libtool commands and not lines which show commands executed
55 # by libtool (e.g. libtool: link: ...).
56 my $libtool_regex = qr/\blibtool["']?\s.*--mode=/;
57 my $libtool_link_regex = qr/\blibtool: link: /;
58
59 # List of source file extensions which require preprocessing.
60 my @source_preprocess_compile_cpp = (
61     # C++
62     qw( cc cp cxx cpp CPP c++ C ),
63     # Objective-C++
64     qw( mm M ),
65 );
66 my @source_preprocess_compile_fortran = (
67     # Fortran
68     qw( F FOR fpp FPP FTN F90 F95 F03 F08 ),
69 );
70 my @source_preprocess_compile = (
71     # C
72     qw( c ),
73     # Objective-C
74     qw( m ),
75     # (Objective-)C++
76     @source_preprocess_compile_cpp,
77     # Fortran
78     @source_preprocess_compile_fortran,
79 );
80 my @source_preprocess_no_compile = (
81     # Assembly
82     qw( S sx ),
83 );
84 my @source_preprocess = (
85     @source_preprocess_compile,
86     @source_preprocess_no_compile,
87 );
88 # List of source file extensions which don't require preprocessing.
89 my @source_no_preprocess_compile_cpp = (
90     # C++
91     qw( ii ),
92     # Objective-C++
93     qw( mii ),
94 );
95 my @source_no_preprocess_compile_ada = (
96     # Ada source
97     qw( ada ),
98     # Ada body
99     qw( adb ),
100 );
101 my @source_no_preprocess_compile_fortran = (
102     # Fortran
103     qw( f for ftn f90 f95 f03 f08 ),
104 );
105 my @source_no_preprocess_compile = (
106     # C
107     qw( i ),
108     # (Objective-)C++
109     @source_no_preprocess_compile_cpp,
110     # Objective-C
111     qw( mi ),
112     # Fortran
113     @source_no_preprocess_compile_fortran,
114     # Ada
115     @source_no_preprocess_compile_ada,
116 );
117 my @source_no_preprocess_no_compile_ada = (
118     # Ada specification
119     qw( ads ),
120 );
121 my @source_no_preprocess_no_compile = (
122     # Assembly
123     qw( s ),
124     # Ada
125     @source_no_preprocess_no_compile_ada,
126 );
127 my @source_no_preprocess = (
128     @source_no_preprocess_compile,
129     @source_no_preprocess_no_compile,
130 );
131 # List of header file extensions which require preprocessing.
132 my @header_preprocess = (
133     # C, C++, Objective-C, Objective-C++
134     qw( h ),
135     # C++
136     qw( hh H hp hxx hpp HPP h++ tcc ),
137 );
138 # Object files.
139 my @object = (
140     # Normal object files.
141     qw ( o ),
142     # Libtool object files.
143     qw ( lo la ),
144     # Dynamic libraries. bzip2 uses .sho.
145     qw ( so sho ),
146     # Static libraries.
147     qw ( a ),
148 );
149
150 # Hashes for fast extensions lookup to check if a file falls in one of these
151 # categories.
152 my %extensions_no_preprocess = map { $_ => 1 } (
153     # There's no @header_no_preprocess.
154     @source_no_preprocess,
155 );
156 my %extensions_preprocess = map { $_ => 1 } (
157     @header_preprocess,
158     @source_preprocess,
159 );
160 my %extensions_compile_link = map { $_ => 1 } (
161     @source_preprocess,
162     @source_no_preprocess,
163 );
164 my %extensions_compile = map { $_ => 1 } (
165     @source_preprocess_compile,
166     @source_no_preprocess_compile,
167 );
168 my %extensions_no_compile = map { $_ => 1 } (
169     @source_preprocess_no_compile,
170     @source_no_preprocess_no_compile,
171 );
172 my %extensions_compile_cpp = map { $_ => 1 } (
173     @source_preprocess_compile_cpp,
174     @source_no_preprocess_compile_cpp,
175 );
176 my %extensions_ada = map { $_ => 1 } (
177     @source_no_preprocess_compile_ada,
178     @source_no_preprocess_no_compile_ada,
179 );
180 my %extensions_fortran = map { $_ => 1 } (
181     @source_no_preprocess_compile_fortran,
182     @source_preprocess_compile_fortran,
183 );
184 my %extensions_object = map { $_ => 1 } (
185     @object,
186 );
187 my %extension = map { $_ => 1 } (
188     @source_no_preprocess,
189     @header_preprocess,
190     @source_preprocess,
191     @object,
192 );
193
194 # Regexp to match file extensions.
195 my $file_extension_regex = qr/
196     \s
197     \S+             # Filename without extension.
198     \.
199     ([^\/\\.,;:\s]+)# File extension.
200     (?=\s|\\)       # At end of word. Can't use \b because some files have non
201                     # word characters at the end and because \b matches double
202                     # extensions (like .cpp.o). Works always as all lines are
203                     # terminated with "\n".
204     /x;
205
206 # Expected (hardening) flags. All flags are used as regexps (and compiled to
207 # real regexps below for better execution speed).
208 my @def_cflags = (
209     '-g',
210     '-O(?:2|3)', # keep at index 1, search for @def_cflags_debug to change it
211 );
212 my @def_cflags_debug = (
213     # These flags indicate a debug build which disables checks for -O2.
214     '-O0',
215     '-Og',
216 );
217 my @def_cflags_format = (
218     '-Wformat(?:=2)?', # -Wformat=2 implies -Wformat, accept it too
219     '-Werror=format-security', # implies -Wformat-security
220 );
221 my @def_cflags_fortify = (
222     # fortify needs at least -O1, but -O2 is recommended anyway
223 );
224 my @def_cflags_stack = (
225     '-fstack-protector', # keep first, used by cflags_stack_broken()
226     '--param[= ]ssp-buffer-size=4',
227 );
228 my @def_cflags_stack_strong = (
229     '-fstack-protector-strong', # keep first, used by cflags_stack_broken()
230 );
231 my @def_cflags_stack_bad = (
232     # Blacklist all stack protector options for simplicity.
233     '-fno-stack-protector',
234     '-fno-stack-protector-all',
235     '-fno-stack-protector-strong',
236 );
237 my @def_cflags_pie = (
238     '-fPIE',
239 );
240 my @def_cxxflags = (
241     @def_cflags,
242 );
243 # @def_cxxflags_* is the same as @def_cflags_*.
244 my @def_cppflags = ();
245 my @def_cppflags_fortify = (
246     '-D_FORTIFY_SOURCE=2', # must be first, see cppflags_fortify_broken()
247     # If you add another flag fix hack below (search for "Hack to fix") and
248     # $def_cppflags_fortify[0].
249 );
250 my @def_cppflags_fortify_bad = (
251     # These flags may overwrite -D_FORTIFY_SOURCE=2.
252     '-U_FORTIFY_SOURCE',
253     '-D_FORTIFY_SOURCE=0',
254     '-D_FORTIFY_SOURCE=1',
255 );
256 my @def_ldflags = ();
257 my @def_ldflags_relro = (
258     '-Wl,(?:-z,)?relro',
259 );
260 my @def_ldflags_bindnow = (
261     '-Wl,(?:-z,)?now',
262 );
263 my @def_ldflags_pie = (
264     '-fPIE',
265     '-pie',
266 );
267 my @def_ldflags_pic = (
268     '-fPIC',
269     '-fpic',
270     '-shared',
271 );
272 # References to all flags checked by the flag checker.
273 my @flag_refs = (
274     \@def_cflags,
275     \@def_cflags_format,
276     \@def_cflags_fortify,
277     \@def_cflags_stack,
278     \@def_cflags_stack_strong,
279     \@def_cflags_stack_bad,
280     \@def_cflags_pie,
281     \@def_cxxflags,
282     \@def_cppflags,
283     \@def_cppflags_fortify,
284     \@def_ldflags,
285     \@def_ldflags_relro,
286     \@def_ldflags_bindnow,
287     \@def_ldflags_pie,
288 );
289 # References to all used flags.
290 my @flag_refs_all = (
291     @flag_refs,
292     \@def_cflags_debug,
293     \@def_cppflags_fortify_bad,
294     \@def_ldflags_pic,
295 );
296 # Renaming rules for the output so the regex parts are not visible. Also
297 # stores string values of flag regexps above, see compile_flag_regexp().
298 my %flag_renames = (
299     '-O(?:2|3)'                    => '-O2',
300     '-Wformat(?:=2)?'              => '-Wformat',
301     '--param[= ]ssp-buffer-size=4' => '--param=ssp-buffer-size=4',
302     '-Wl,(?:-z,)?relro'            => '-Wl,-z,relro',
303     '-Wl,(?:-z,)?now'              => '-Wl,-z,now',
304 );
305
306 my %exit_code = (
307     no_compiler_commands => 1 << 0,
308     # used by POD::Usage => 1 << 1,
309     non_verbose_build    => 1 << 2,
310     flags_missing        => 1 << 3,
311     hardening_wrapper    => 1 << 4,
312     invalid_cmake        => 1 << 5,
313 );
314
315 my %buildd_tag = (
316     no_compiler_commands => 'I-no-compiler-commands',
317     non_verbose_build    => 'W-compiler-flags-hidden',
318     flags_missing        => 'W-dpkg-buildflags-missing',
319     hardening_wrapper    => 'I-hardening-wrapper-used',
320     invalid_cmake        => 'I-invalid-cmake-used',
321 );
322
323 # Statistics of missing flags and non-verbose build commands. Used for
324 # $option_buildd.
325 my %statistics = (
326     preprocess          => 0,
327     preprocess_missing  => 0,
328     compile             => 0,
329     compile_missing     => 0,
330     compile_cpp         => 0,
331     compile_cpp_missing => 0,
332     link                => 0,
333     link_missing        => 0,
334     commands            => 0,
335     commands_nonverbose => 0,
336 );
337
338 # Use colored (ANSI) output?
339 my $option_color;
340
341
342 # FUNCTIONS
343
344 # Only works for single-level arrays with no undef values. Thanks to perlfaq4.
345 sub array_equal {
346     my ($first_ref, $second_ref) = @_;
347
348     return 0 if scalar @{$first_ref} != scalar @{$second_ref};
349
350     my $length = scalar @{$first_ref};
351     for (my $i = 0; $i < $length; $i++) {
352         return 0 if $first_ref->[$i] ne $second_ref->[$i];
353     }
354
355     return 1;
356 }
357
358 sub error_flags {
359     my ($message, $missing_flags_ref, $flag_renames_ref, $line, $number) = @_;
360
361     # Get string value of qr//-escaped regexps and if requested rename them.
362     my @missing_flags = map {
363             $flag_renames_ref->{$_}
364         } @{$missing_flags_ref};
365
366     my $flags = join ' ', @missing_flags;
367     printf '%d:', $number if defined $number;
368     printf '%s (%s)%s %s',
369            error_color($message, 'red'), $flags, error_color(':', 'yellow'),
370            $line;
371
372     return;
373 }
374 sub error_non_verbose_build {
375     my ($line, $number) = @_;
376
377     printf '%d:', $number if defined $number;
378     printf '%s%s %s',
379            error_color('NONVERBOSE BUILD', 'red'),
380            error_color(':', 'yellow'),
381            $line;
382
383     return;
384 }
385 sub error_invalid_cmake {
386     my ($version) = @_;
387
388     printf "%s%s %s\n",
389             error_color('INVALID CMAKE', 'red'),
390             error_color(':', 'yellow'),
391             $version;
392
393     return;
394 }
395 sub error_hardening_wrapper {
396     printf "%s%s %s\n",
397             error_color('HARDENING WRAPPER', 'red'),
398             error_color(':', 'yellow'),
399             'no checks possible, aborting';
400
401     return;
402 }
403 sub error_color {
404     my ($message, $color) = @_;
405
406     if ($option_color) {
407         return Term::ANSIColor::colored($message, $color);
408     } else {
409         return $message;
410     }
411 }
412
413 sub any_flags_used {
414     my ($line, @flags) = @_;
415
416     foreach my $flag (@flags) {
417         return 1 if $line =~ /$flag/;
418     }
419
420     return 0;
421 }
422 sub all_flags_used {
423     my ($line, $missing_flags_ref, @flags) = @_;
424
425     my @missing_flags = ();
426     foreach my $flag (@flags) {
427         if (not $line =~ /$flag/) {
428             push @missing_flags, $flag;
429         }
430     }
431
432     return 1 if scalar @missing_flags == 0;
433
434     @{$missing_flags_ref} = @missing_flags;
435     return 0;
436 }
437 # Check if any of \@bad_flags occurs after $good_flag. Doesn't check if
438 # $good_flag is present.
439 sub flag_overwritten {
440     my ($line, $good_flag, $bad_flags) = @_;
441
442     if (not any_flags_used($line, @{$bad_flags})) {
443         return 0;
444     }
445
446     my $bad_pos = 0;
447     foreach my $flag (@{$bad_flags}) {
448         while ($line =~ /$flag/g) {
449             if ($bad_pos < $+[0]) {
450                 $bad_pos = $+[0];
451             }
452         }
453     }
454     my $good_pos = 0;
455     while ($line =~ /$good_flag/g) {
456         $good_pos = $+[0];
457     }
458     if ($good_pos > $bad_pos) {
459         return 0;
460     }
461     return 1;
462 }
463
464 sub cppflags_fortify_broken {
465     my ($line, $missing_flags) = @_;
466
467     # $def_cppflags_fortify[0] must be -D_FORTIFY_SOURCE=2!
468     my $fortify_source = $def_cppflags_fortify[0];
469
470     # Some build systems enable/disable fortify source multiple times, check
471     # the final result.
472     if (not flag_overwritten($line,
473                              $fortify_source,
474                              \@def_cppflags_fortify_bad)) {
475         return 0;
476     }
477     push @{$missing_flags}, $fortify_source;
478     return 1;
479 }
480
481 sub cflags_stack_broken {
482     my ($line, $missing_flags, $strong) = @_;
483
484     my $flag = $strong ? $def_cflags_stack_strong[0]
485                        : $def_cflags_stack[0];
486
487     if (not flag_overwritten($line, $flag, \@def_cflags_stack_bad)) {
488         return 0;
489     }
490     push @{$missing_flags}, $flag;
491     return 1;
492 }
493
494 # Modifies $missing_flags_ref array.
495 sub pic_pie_conflict {
496     my ($line, $pie, $missing_flags_ref, @flags_pie) = @_;
497
498     return 0 if not $pie;
499     return 0 if not any_flags_used($line, @def_ldflags_pic);
500
501     my %flags = map { $_ => 1 } @flags_pie;
502
503     # Remove all PIE flags from @missing_flags as they are not required with
504     # -fPIC.
505     my @result = grep {
506         not exists $flags{$_}
507     } @{$missing_flags_ref};
508     @{$missing_flags_ref} = @result;
509
510     # We got a conflict when no flags are left, thus only PIE flags were
511     # missing. If other flags were missing abort because the conflict is not
512     # the problem.
513     return scalar @result == 0;
514 }
515
516 sub is_non_verbose_build {
517     my ($line, $skip_ref, $input_ref, $line_offset, $line_count) = @_;
518
519     if ($line =~ /$libtool_regex/o) {
520         # libtool's --silent hides the real compiler flags.
521         if ($line =~ /\s--silent/) {
522             return 1;
523         # If --silent is not present, skip this line as some compiler flags
524         # might be missing (e.g. -fPIE) which are handled correctly by libtool
525         # internally. libtool displays the real compiler command on the next
526         # line, so the flags are checked as usual.
527         } else {
528             ${$skip_ref} = 1;
529             return 0;
530         }
531     }
532
533     if (not (index($line, 'checking if you want to see long compiling messages... no') == 0
534                 or $line =~ /^\s*\[?(?:CC|CCLD|C\+\+|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/
535                 or $line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
536                 or $line =~ /^\s*[Bb]uilding (?:program|shared library)\s+(.+?)$/
537                 or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
538         return 0;
539     }
540
541     # False positives.
542     #
543     # C++ compiler setting.
544     return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
545     return 0 if $line =~ /^\s*C\+\+ Library: stdc\+\+$/;
546     # "Compiling" non binary files.
547     return 0 if $line =~ /^\s*Compiling \S+\.(?:py|pyx|el)['"]?\s*(?:\.\.\.|because it changed\.)?$/;
548     return 0 if $line =~ /^\s*[Cc]ompiling catalog \S+\.po\b/;
549     # "Compiling" with no file name.
550     if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) {
551         # $file_extension_regex may need spaces around the filename.
552         return 0 if not " $1 " =~ /$file_extension_regex/o;
553     }
554
555     my $file = $1;
556
557     # On the first pass we only check if this line is verbose or not.
558     return 1 if not defined $input_ref;
559
560     # Second pass, we have access to the next lines.
561     ${$skip_ref} = 0;
562
563     # CMake and other build systems print the non-verbose messages also when
564     # building verbose. If a compiler and the file name occurs in the next
565     # lines, treat it as verbose build.
566     if (defined $file) {
567         # Get filename, we can't use the complete path as only parts of it are
568         # used in the real compiler command.
569         $file =~ m{/([^/\s]+)$};
570         $file = $1;
571
572         for (my $i = 1; $i <= $line_count; $i++) {
573             my $next_line = $input_ref->[$line_offset + $i];
574             last unless defined $next_line;
575
576             if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
577                 # Not a non-verbose line, but we still have to skip the
578                 # current line as it doesn't contain any compiler commands.
579                 ${$skip_ref} = 1;
580                 return 0;
581             }
582         }
583     }
584
585     return 1;
586 }
587
588 # Remove @flags from $flag_refs_ref, uses $flag_renames_ref as reference.
589 sub remove_flags {
590     my ($flag_refs_ref, $flag_renames_ref, @flags) = @_;
591
592     my %removes = map { $_ => 1 } @flags;
593     foreach my $flags (@{$flag_refs_ref}) {
594         @{$flags} = grep {
595             # Flag found as string.
596             not exists $removes{$_}
597             # Flag found as string representation of regexp.
598                 and (not defined $flag_renames_ref->{$_}
599                         or not exists $removes{$flag_renames_ref->{$_}})
600         } @{$flags};
601     }
602
603     return;
604 }
605
606 # Modifies $flag_renames_ref hash.
607 sub compile_flag_regexp {
608     my ($flag_renames_ref, @flags) = @_;
609
610     my @result = ();
611     foreach my $flag (@flags) {
612         # Compile flag regexp for faster execution.
613         my $regex = qr/\s$flag(?:\s|\\)/;
614
615         # Store flag name in replacement string for correct flags in messages
616         # with qr//ed flag regexps.
617         $flag_renames_ref->{$regex}
618             = (exists $flag_renames_ref->{$flag})
619                 ? $flag_renames_ref->{$flag}
620                 : $flag;
621
622         push @result, $regex;
623     }
624     return @result;
625 }
626
627 # Does any extension in @extensions exist in %{$extensions_ref}?
628 sub extension_found {
629     my ($extensions_ref, @extensions) = @_;
630
631     foreach my $extension (@extensions) {
632         if (exists $extensions_ref->{$extension}) {
633             return 1;
634         }
635     }
636     return 0;
637 }
638
639
640 # MAIN
641
642 # Parse command line arguments.
643 my $option_help             = 0;
644 my $option_version          = 0;
645 my $option_pie              = 0;
646 my $option_bindnow          = 0;
647 my @option_ignore_arch      = ();
648 my @option_ignore_flag      = ();
649 my @option_ignore_arch_flag = ();
650 my @option_ignore_line      = ();
651 my @option_ignore_arch_line = ();
652 my $option_all              = 0;
653 my $option_arch             = undef;
654 my $option_buildd           = 0;
655 my $option_debian           = 0;
656    $option_color            = 0;
657 my $option_line_numbers     = 0;
658 if (not Getopt::Long::GetOptions(
659             'help|h|?'           => \$option_help,
660             'version'            => \$option_version,
661             # Hardening options.
662             'pie'                => \$option_pie,
663             'bindnow'            => \$option_bindnow,
664             'all'                => \$option_all,
665             # Ignore.
666             'ignore-arch=s'      => \@option_ignore_arch,
667             'ignore-flag=s'      => \@option_ignore_flag,
668             'ignore-arch-flag=s' => \@option_ignore_arch_flag,
669             'ignore-line=s'      => \@option_ignore_line,
670             'ignore-arch-line=s' => \@option_ignore_arch_line,
671             # Misc.
672             'color'              => \$option_color,
673             'arch=s'             => \$option_arch,
674             'buildd'             => \$option_buildd,
675             'debian'             => \$option_debian,
676             'line-numbers'       => \$option_line_numbers,
677         )) {
678     require Pod::Usage;
679     Pod::Usage::pod2usage(2);
680 }
681 if ($option_help) {
682     require Pod::Usage;
683     Pod::Usage::pod2usage(1);
684 }
685 if ($option_version) {
686     print <<"EOF";
687 blhc $VERSION  Copyright (C) 2012-2020  Simon Ruderich
688
689 This program is free software: you can redistribute it and/or modify
690 it under the terms of the GNU General Public License as published by
691 the Free Software Foundation, either version 3 of the License, or
692 (at your option) any later version.
693
694 This program is distributed in the hope that it will be useful,
695 but WITHOUT ANY WARRANTY; without even the implied warranty of
696 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
697 GNU General Public License for more details.
698
699 You should have received a copy of the GNU General Public License
700 along with this program.  If not, see <http://www.gnu.org/licenses/>.
701 EOF
702     exit 0;
703 }
704
705 # Arguments missing.
706 if (scalar @ARGV == 0) {
707     require Pod::Usage;
708     Pod::Usage::pod2usage(2);
709 }
710
711 # Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not
712 # installed on Debian's buildds.
713 if (not $option_buildd) {
714     require Term::ANSIColor;
715 }
716
717 if ($option_all) {
718     $option_pie     = 1;
719     $option_bindnow = 1;
720 }
721
722 # Precompiled ignores for faster lookup.
723 my %option_ignore_arch_flag = ();
724 my %option_ignore_arch_line = ();
725
726 # Strip flags which should be ignored.
727 if (scalar @option_ignore_flag > 0) {
728     remove_flags(\@flag_refs, \%flag_renames, @option_ignore_flag);
729 }
730 # Same for arch specific ignore flags, but only prepare here.
731 if (scalar @option_ignore_arch_flag > 0) {
732     foreach my $ignore (@option_ignore_arch_flag) {
733         my ($ignore_arch, $ignore_flag) = split /:/, $ignore, 2;
734
735         if (not $ignore_arch or not $ignore_flag) {
736             printf STDERR 'Value "%s" invalid for option ignore-arch-flag '
737                         . '("arch:flag" expected)' . "\n", $ignore;
738             require Pod::Usage;
739             Pod::Usage::pod2usage(2);
740         }
741
742         push @{$option_ignore_arch_flag{$ignore_arch}}, $ignore_flag;
743     }
744 }
745
746 # Precompile all flag regexps. any_flags_used(), all_flags_used() get a lot
747 # faster with this.
748 foreach my $flags (@flag_refs_all) {
749     @{$flags} = compile_flag_regexp(\%flag_renames, @{$flags});
750 }
751
752 # Precompile ignore line regexps, also anchor at beginning and end of line.
753 foreach my $ignore (@option_ignore_line) {
754     $ignore = qr/^$ignore$/;
755 }
756 # Same for arch specific ignore lines.
757 if (scalar @option_ignore_arch_line > 0) {
758     foreach my $ignore (@option_ignore_arch_line) {
759         my ($ignore_arch, $ignore_line) = split /:/, $ignore, 2;
760
761         if (not $ignore_arch or not $ignore_line) {
762             printf STDERR 'Value "%s" invalid for option ignore-arch-line '
763                         . '("arch:line" expected)' . "\n", $ignore;
764             require Pod::Usage;
765             Pod::Usage::pod2usage(2);
766         }
767
768         push @{$option_ignore_arch_line{$ignore_arch}}, qr/^$ignore_line$/;
769     }
770 }
771
772 # Final exit code.
773 my $exit = 0;
774
775 FILE:
776 foreach my $file (@ARGV) {
777     print "checking '$file'...\n" if scalar @ARGV > 1;
778
779     -f $file or die "No such file: $file";
780
781     open my $fh, '<', $file or die $!;
782
783     # Architecture of this file.
784     my $arch = $option_arch;
785
786     # Hardening options. Not all architectures support all hardening options.
787     my $harden_format  = 1;
788     my $harden_fortify = 1;
789     my $harden_stack   = 1;
790     my $harden_stack_strong = 1;
791     my $harden_relro   = 1;
792     my $harden_bindnow = $option_bindnow; # defaults to 0
793     my $harden_pie     = $option_pie;     # defaults to 0
794
795     # Number of parallel jobs to prevent false positives when detecting
796     # non-verbose builds. As not all jobs declare the number of parallel jobs
797     # use a large enough default.
798     my $parallel = 10;
799
800     # Don't check for PIE flags if automatically applied by the compiler. Only
801     # used in buildd and Debian mode.
802     my $disable_harden_pie = 0;
803     if ($option_debian) {
804         $disable_harden_pie = 1;
805     }
806
807     my $number = 0;
808     while (my $line = <$fh>) {
809         $number++;
810
811         # Detect architecture automatically unless overridden. For buildd logs
812         # only, doesn't use the dpkg-buildpackage header. Necessary to ignore
813         # build logs which aren't built (wrong architecture, build error,
814         # etc.).
815         if (not $arch) {
816             if (index($line, 'Build Architecture: ') == 0) {
817                 $arch = substr $line, 20, -1; # -1 to ignore '\n' at the end
818             # For old logs (sbuild << 0.63.0-1).
819             } elsif (index($line, 'Architecture: ') == 0) {
820                 $arch = substr $line, 14, -1; # -1 to ignore '\n' at the end
821             }
822         }
823
824         # dpkg-buildflags only provides hardening flags since 1.16.1, don't
825         # check for hardening flags in buildd mode if an older dpkg-dev is
826         # used. Default flags (-g -O2) are still checked.
827         #
828         # Packages which were built before 1.16.1 but used their own hardening
829         # flags are not checked.
830         #
831         # Strong stack protector is used since dpkg 1.17.11.
832         #
833         # Recent GCC versions automatically use PIE (only on supported
834         # architectures) and dpkg respects this properly since 1.18.15 and
835         # doesn't pass PIE flags manually.
836         if ($option_buildd
837                 and index($line, 'Toolchain package versions: ') == 0) {
838             require Dpkg::Version;
839
840             my $disable = 1;
841             my $disable_strong = 1;
842
843             if ($line =~ /\bdpkg-dev_(\S+)/) {
844                 if (Dpkg::Version::version_compare($1, '1.16.1') >= 0) {
845                     $disable = 0;
846                 }
847                 if (Dpkg::Version::version_compare($1, '1.17.11') >= 0) {
848                     $disable_strong = 0;
849                 }
850                 if (Dpkg::Version::version_compare($1, '1.18.15') >= 0) {
851                     $disable_harden_pie = 1;
852                 }
853             }
854
855             if ($disable) {
856                 $harden_format  = 0;
857                 $harden_fortify = 0;
858                 $harden_stack   = 0;
859                 $harden_relro   = 0;
860                 $harden_bindnow = 0;
861                 $harden_pie     = 0;
862             }
863             if ($disable_strong) {
864                 $harden_stack_strong = 0;
865             }
866         }
867
868         # The following two versions of CMake in Debian obeyed CPPFLAGS, but
869         # this was later dropped because upstream rejected the patch. Thus
870         # build logs with these versions will have fortify hardening flags
871         # enabled, even though they may be not correctly set and are missing
872         # when build with later CMake versions. Thanks to Aron Xu for letting
873         # me know.
874         if (index($line, 'Package versions: ') == 0
875                 and $line =~ /\bcmake_(\S+)/
876                 and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
877             if (not $option_buildd) {
878                 error_invalid_cmake($1);
879                 $exit |= $exit_code{invalid_cmake};
880             } else {
881                 print "$buildd_tag{invalid_cmake}|$1|\n";
882             }
883         }
884
885         # Debian's build daemons use "Filtered Build-Depends:" (or just
886         # "Build-Depends:" in older versions) for the build dependencies, but
887         # pbuilder uses "Depends:"; support both.
888         if (index($line, 'Filtered Build-Depends: ') == 0
889                 or index($line, 'Build-Depends: ') == 0
890                 or index($line, 'Depends: ') == 0) {
891             # If hardening wrapper is used (wraps calls to gcc and adds
892             # hardening flags automatically) we can't perform any checks,
893             # abort.
894             if ($line =~ /\bhardening-wrapper\b/) {
895                 if (not $option_buildd) {
896                     error_hardening_wrapper();
897                     $exit |= $exit_code{hardening_wrapper};
898                 } else {
899                     print "$buildd_tag{hardening_wrapper}||\n";
900                 }
901                 next FILE;
902             }
903         }
904
905         # This flags is not always available, but if it is use it.
906         if ($line =~ /^DEB_BUILD_OPTIONS=.*\bparallel=(\d+)/) {
907             $parallel = $1 * 2;
908         }
909
910         # We skip over unimportant lines at the beginning of the log to
911         # prevent false positives.
912         last if index($line, 'dpkg-buildpackage: ') == 0;
913     }
914
915     # Input lines, contain only the lines with compiler commands.
916     my @input = ();
917     # Non-verbose lines in the input. Used to reduce calls to
918     # is_non_verbose_build() (which is quite slow) in the second loop when
919     # it's already clear if a line is non-verbose or not.
920     my @input_nonverbose = ();
921     # Input line number.
922     my @input_number = ();
923
924     my $continuation = 0;
925     my $complete_line = undef;
926     my $non_verbose;
927     while (my $line = <$fh>) {
928         $number++;
929
930         # And stop at the end of the build log. Package details (reported by
931         # the buildd logs) are not important for us. This also prevents false
932         # positives.
933         last if index($line, 'Build finished at ') == 0
934                 and $line =~ /^Build finished at \d{8}-\d{4}$/;
935
936         if (not $continuation) {
937             $non_verbose = 0;
938         }
939
940         # Detect architecture automatically unless overridden.
941         if (not $arch
942                 and index($line, 'dpkg-buildpackage: info: host architecture ') == 0) {
943             $arch = substr $line, 43, -1; # -1 to ignore '\n' at the end
944         # Older versions of dpkg-buildpackage
945         } elsif (not $arch
946                 and index($line, 'dpkg-buildpackage: host architecture ') == 0) {
947             $arch = substr $line, 37, -1; # -1 to ignore '\n' at the end
948
949             # Old buildd logs use e.g. "host architecture is alpha", remove
950             # the "is", otherwise debarch_to_debtriplet() will not detect the
951             # architecture.
952             if (index($arch, 'is ') == 0) {
953                 $arch = substr $arch, 3;
954             }
955         }
956
957         next if $line =~ /^\s*#/;
958         # Ignore compiler warnings for now.
959         next if $line =~ /$warning_regex/o;
960
961         if (not $option_buildd and index($line, "\033") != -1) { # \033 = esc
962             # Remove all ANSI color sequences which are sometimes used in
963             # non-verbose builds.
964             $line = Term::ANSIColor::colorstrip($line);
965             # Also strip '\0xf' (delete previous character), used by Elinks'
966             # build system.
967             $line =~ s/\x0f//g;
968             # And "ESC(B" which seems to be used on armhf and hurd (not sure
969             # what it does).
970             $line =~ s/\033\(B//g;
971         }
972
973         # Check if this line indicates a non verbose build.
974         my $skip = 0;
975         $non_verbose |= is_non_verbose_build($line, \$skip);
976         next if $skip;
977
978         # One line may contain multiple commands (";"). Treat each one as
979         # single line. parse_line() is slow, only use it when necessary.
980         my @line = (index($line, ';') == -1)
981                  ? ($line)
982                  : map {
983                        # Ensure newline at the line end - necessary for
984                        # correct parsing later.
985                        $_ =~ s/\s+$//;
986                        $_ .= "\n";
987                    } Text::ParseWords::parse_line(';', 1, $line);
988         foreach my $line (@line) {
989             if ($continuation) {
990                 $continuation = 0;
991
992                 # Join lines, but leave the "\" in place so it's clear where
993                 # the original line break was.
994                 chomp $complete_line;
995                 $complete_line .= ' ' . $line;
996             }
997             # Line continuation, line ends with "\".
998             if ($line =~ /\\$/) {
999                 $continuation = 1;
1000                 # Start line continuation.
1001                 if (not defined $complete_line) {
1002                     $complete_line = $line;
1003                 }
1004                 next;
1005             }
1006
1007             # Use the complete line if a line continuation occurred.
1008             if (defined $complete_line) {
1009                 $line = $complete_line;
1010                 $complete_line = undef;
1011             }
1012
1013             # Ignore lines with no compiler commands.
1014             next if not $non_verbose
1015                     and not $line =~ /$cc_regex_normal/o;
1016             # Ignore lines with no filenames with extensions. May miss some
1017             # non-verbose builds (e.g. "gcc -o test" [sic!]), but shouldn't be
1018             # a problem as the log will most likely contain other non-verbose
1019             # commands which are detected.
1020             next if not $non_verbose
1021                     and not $line =~ /$file_extension_regex/o;
1022
1023             # Ignore false positives.
1024             #
1025             # `./configure` output.
1026             next if not $non_verbose
1027                     and $line =~ /^(?:checking|[Cc]onfigure:) /;
1028             next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
1029                                 [Cc]ompiler[\s.]*:?\s+
1030                                 /x;
1031             next if $line =~ m{^\s*(?:-\s)?(?:HOST_)?(?:CC|CXX)
1032                                 \s*=\s*$cc_regex_full
1033                                 # optional compiler options, don't allow
1034                                 # "everything" here to prevent false negatives
1035                                 \s*(?:\s-\S+)*\s*$}xo;
1036             # `moc-qt4`/`moc-qt5` contain '-I.../linux-g++' in their command
1037             # line (or similar for other architectures) which gets recognized
1038             # as a compiler line, but `moc-qt*` is only a preprocessor for Qt
1039             # C++ files. No hardening flags are relevant during this step,
1040             # thus ignore `moc-qt*` lines. The resulting files will be
1041             # compiled in a separate step (and therefore checked).
1042             next if $line =~ m{^\S+/bin/moc(?:-qt[45])?
1043                                \s.+\s
1044                                -I\S+/mkspecs/[a-z]+-g\++(?:-64)?
1045                                \s}x;
1046             # Ignore false positives when the line contains only CC=gcc but no
1047             # other gcc command.
1048             if ($line =~ /(.*)CC=$cc_regex_full(.*)/o) {
1049                 my $before = $1;
1050                 my $after  = $2;
1051                 next if     not $before =~ /$cc_regex_normal/o
1052                         and not $after  =~ /$cc_regex_normal/o;
1053             }
1054             # Ignore false positives caused by gcc -v. It outputs a line
1055             # looking like a normal compiler line but which is sometimes
1056             # missing hardening flags, although the normal compiler line
1057             # contains them.
1058             next if $line =~ m{^\s+/usr/lib/gcc/$cc_regex_full_prefix/
1059                                    [0-9.]+/cc1(?:plus)?}xo;
1060             # Ignore false positive with `rm` which may remove files which
1061             # look like a compiler executable thus causing the line to be
1062             # treated as a normal compiler line.
1063             next if $line =~ m{^\s*rm\s+};
1064             next if $line =~ m{^\s*dwz\s+};
1065             # Some build systems emit "gcc > file".
1066             next if $line =~ m{$cc_regex_normal\s*>\s*\S+}o;
1067             # Hex output may contain "cc".
1068             next if $line =~ m#(?:\b[0-9a-fA-F]{2,}\b\s*){5}#;
1069
1070             # Check if additional hardening options were used. Used to ensure
1071             # they are used for the complete build.
1072             $harden_pie     = 1 if any_flags_used($line, @def_cflags_pie,
1073                                                          @def_ldflags_pie);
1074             $harden_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
1075
1076             push @input, $line;
1077             push @input_nonverbose, $non_verbose;
1078             push @input_number, $number if $option_line_numbers;
1079         }
1080     }
1081
1082     close $fh or die $!;
1083
1084     # Ignore arch if requested.
1085     if (scalar @option_ignore_arch > 0 and $arch) {
1086         foreach my $ignore (@option_ignore_arch) {
1087             if ($arch eq $ignore) {
1088                 print "ignoring architecture '$arch'\n";
1089                 next FILE;
1090             }
1091         }
1092     }
1093
1094     if (scalar @input == 0) {
1095         if (not $option_buildd) {
1096             print "No compiler commands!\n";
1097             $exit |= $exit_code{no_compiler_commands};
1098         } else {
1099             print "$buildd_tag{no_compiler_commands}||\n";
1100         }
1101         next FILE;
1102     }
1103
1104     if ($option_buildd) {
1105         $statistics{commands} += scalar @input;
1106     }
1107
1108     # Option or auto detected.
1109     if ($arch) {
1110         # The following was partially copied from dpkg-dev 1.20.5
1111         # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, _add_build_flags()),
1112         # copyright RaphaĆ«l Hertzog <hertzog@debian.org>, Guillem Jover
1113         # <guillem@debian.org>, Kees Cook <kees@debian.org>, Canonical, Ltd.
1114         # licensed under GPL version 2 or later. Keep it in sync.
1115
1116         require Dpkg::Arch;
1117         my ($os, $cpu);
1118         # Recent dpkg versions use a quadruplet for arch. Support both.
1119         eval {
1120             (undef, undef, $os, $cpu) = Dpkg::Arch::debarch_to_debtuple($arch);
1121         };
1122         if ($@) {
1123             (undef, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
1124         }
1125
1126         my %builtin_pie_arch = map { $_ => 1 } qw(
1127             amd64
1128             arm64
1129             armel
1130             armhf
1131             hurd-i386
1132             i386
1133             kfreebsd-amd64
1134             kfreebsd-i386
1135             mips
1136             mipsel
1137             mips64el
1138             powerpc
1139             ppc64
1140             ppc64el
1141             riscv64
1142             s390x
1143             sparc
1144             sparc64
1145         );
1146
1147         # Disable unsupported hardening options.
1148         if ($os !~ /^(?:linux|kfreebsd|knetbsd|hurd)$/
1149                 or $cpu =~ /^(?:hppa|avr32)$/) {
1150             $harden_pie = 0;
1151         }
1152         if ($cpu =~ /^(?:ia64|alpha|hppa|nios2)$/ or $arch eq 'arm') {
1153             $harden_stack = 0;
1154             $harden_stack_strong = 0;
1155         }
1156         if ($cpu =~ /^(?:ia64|hppa|avr32)$/) {
1157             $harden_relro   = 0;
1158             $harden_bindnow = 0;
1159         }
1160
1161         if ($disable_harden_pie and exists $builtin_pie_arch{$arch}) {
1162             $harden_pie = 0;
1163         }
1164     }
1165
1166     # Default values.
1167     my @cflags   = @def_cflags;
1168     my @cxxflags = @def_cxxflags;
1169     my @cppflags = @def_cppflags;
1170     my @ldflags  = @def_ldflags;
1171     # Check the specified hardening options, same order as dpkg-buildflags.
1172     if ($harden_pie) {
1173         @cflags   = (@cflags,   @def_cflags_pie);
1174         @cxxflags = (@cxxflags, @def_cflags_pie);
1175         @ldflags  = (@ldflags,  @def_ldflags_pie);
1176     }
1177     if ($harden_stack_strong) {
1178         @cflags   = (@cflags,   @def_cflags_stack_strong);
1179         @cxxflags = (@cxxflags, @def_cflags_stack_strong);
1180     } elsif ($harden_stack) {
1181         @cflags   = (@cflags,   @def_cflags_stack);
1182         @cxxflags = (@cxxflags, @def_cflags_stack);
1183     }
1184     if ($harden_fortify) {
1185         @cflags   = (@cflags,   @def_cflags_fortify);
1186         @cxxflags = (@cxxflags, @def_cflags_fortify);
1187         @cppflags = (@cppflags, @def_cppflags_fortify);
1188     }
1189     if ($harden_format) {
1190         @cflags   = (@cflags,   @def_cflags_format);
1191         @cxxflags = (@cxxflags, @def_cflags_format);
1192     }
1193     if ($harden_relro) {
1194         @ldflags = (@ldflags, @def_ldflags_relro);
1195     }
1196     if ($harden_bindnow) {
1197         @ldflags = (@ldflags, @def_ldflags_bindnow);
1198     }
1199
1200     # Ada doesn't support format hardening flags, see #680117 for more
1201     # information. Same for fortran.
1202     my @cflags_backup;
1203     my @cflags_noformat = grep {
1204         my $ok = 1;
1205         foreach my $flag (@def_cflags_format) {
1206             $ok = 0 if $_ eq $flag;
1207         }
1208         $ok;
1209     } @cflags;
1210
1211     # Hack to fix cppflags_fortify_broken() if --ignore-flag
1212     # -D_FORTIFY_SOURCE=2 is used to ignore missing fortification. Only works
1213     # as long as @def_cppflags_fortify contains only one variable.
1214     if (scalar @def_cppflags_fortify == 0) {
1215         $harden_fortify = 0;
1216     }
1217
1218     # Ignore flags for this arch if requested.
1219     if ($arch and exists $option_ignore_arch_flag{$arch}) {
1220         my @local_flag_refs = (\@cflags, \@cxxflags, \@cppflags, \@ldflags);
1221
1222         remove_flags(\@local_flag_refs,
1223                      \%flag_renames,
1224                      @{$option_ignore_arch_flag{$arch}});
1225     }
1226
1227     my @ignore_line = @option_ignore_line;
1228     # Ignore lines for this arch if requested.
1229     if ($arch and exists $option_ignore_arch_line{$arch}) {
1230         @ignore_line = (@ignore_line, @{$option_ignore_arch_line{$arch}});
1231     }
1232
1233 LINE:
1234     for (my $i = 0; $i < scalar @input; $i++) {
1235         my $line = $input[$i];
1236
1237         # Ignore line if requested.
1238         foreach my $ignore (@ignore_line) {
1239             next LINE if $line =~ /$ignore/;
1240         }
1241
1242         my $skip = 0;
1243         if ($input_nonverbose[$i]
1244                 and is_non_verbose_build($line, \$skip,
1245                                          \@input, $i, $parallel)) {
1246             if (not $option_buildd) {
1247                 error_non_verbose_build($line, $input_number[$i]);
1248                 $exit |= $exit_code{non_verbose_build};
1249             } else {
1250                 $statistics{commands_nonverbose}++;
1251             }
1252             next;
1253         }
1254         # Even if it's a verbose build, we might have to skip this line (see
1255         # is_non_verbose_build()).
1256         next if $skip;
1257
1258         my $orig_line = $line;
1259
1260         # Remove everything until and including the compiler command. Makes
1261         # checks easier and faster.
1262         $line =~ s/^.*?$cc_regex//o;
1263         # "([...] test.c)" is not detected as 'test.c' - fix this by removing
1264         # the brace and similar characters at the line end.
1265         $line =~ s/['")]+$//;
1266
1267         # Skip unnecessary tests when only preprocessing.
1268         my $flag_preprocess = 0;
1269
1270         my $dependency = 0;
1271         my $preprocess = 0;
1272         my $compile    = 0;
1273         my $link       = 0;
1274
1275         # Preprocess, compile, assemble.
1276         if ($line =~ /\s(-E|-S|-c)\b/) {
1277             $preprocess      = 1;
1278             $flag_preprocess = 1 if $1 eq '-E';
1279             $compile         = 1 if $1 eq '-S' or $1 eq '-c';
1280         # Dependency generation for Makefiles. The other flags (-MF -MG -MP
1281         # -MT -MQ) are always used with -M/-MM.
1282         } elsif ($line =~ /\s(?:-M|-MM)\b/) {
1283             $dependency = 1;
1284         # Otherwise assume we are linking.
1285         } else {
1286             $link = 1;
1287         }
1288
1289         # -MD/-MMD also cause dependency generation, but they don't imply -E!
1290         if ($line =~ /\s(?:-MD|-MMD)\b/) {
1291             $dependency      = 0;
1292             $flag_preprocess = 0;
1293         }
1294
1295         # Dependency generation for Makefiles, no preprocessing or other flags
1296         # needed.
1297         next if $dependency;
1298
1299         # Get all file extensions on this line.
1300         my @extensions = $line =~ /$file_extension_regex/go;
1301         # Ignore all unknown extensions to speedup the search below.
1302         @extensions = grep { exists $extension{$_} } @extensions;
1303
1304         # These file types don't require preprocessing.
1305         if (extension_found(\%extensions_no_preprocess, @extensions)) {
1306             $preprocess = 0;
1307         }
1308         # These file types require preprocessing.
1309         if (extension_found(\%extensions_preprocess, @extensions)) {
1310             # Prevent false positives with "libtool: link: g++ -include test.h
1311             # .." compiler lines.
1312             if ($orig_line !~ /$libtool_link_regex/o) {
1313                 $preprocess = 1;
1314             }
1315         }
1316
1317         if (not $flag_preprocess) {
1318             # If there are source files then it's compiling/linking in one
1319             # step and we must check both. We only check for source files
1320             # here, because header files cause too many false positives.
1321             if (extension_found(\%extensions_compile_link, @extensions)) {
1322                 # Assembly files don't need CFLAGS.
1323                 if (not extension_found(\%extensions_compile, @extensions)
1324                         and extension_found(\%extensions_no_compile, @extensions)) {
1325                     $compile = 0;
1326                 # But the rest does.
1327                 } else {
1328                     $compile = 1;
1329                 }
1330             # No compilable extensions found, either linking or compiling
1331             # header flags.
1332             #
1333             # If there are also no object files we are just compiling headers
1334             # (.h -> .h.gch). Don't check for linker flags in this case. Due
1335             # to our liberal checks for compiler lines, this also reduces the
1336             # number of false positives considerably.
1337             } elsif ($link
1338                     and not extension_found(\%extensions_object, @extensions)) {
1339                 $link = 0;
1340             }
1341         }
1342
1343         my $compile_cpp = 0;
1344         my $restore_cflags = 0;
1345         # Assume CXXFLAGS are required when a C++ file is specified in the
1346         # compiler line.
1347         if ($compile
1348                 and extension_found(\%extensions_compile_cpp, @extensions)) {
1349             $compile     = 0;
1350             $compile_cpp = 1;
1351         # Ada needs special CFLAGS
1352         } elsif (extension_found(\%extensions_ada, @extensions)) {
1353             $restore_cflags = 1;
1354             $preprocess = 0; # Ada uses no CPPFLAGS
1355             @cflags_backup = @cflags;
1356             @cflags        = @cflags_noformat;
1357         # Same for fortran
1358         } elsif (extension_found(\%extensions_fortran, @extensions)) {
1359             $restore_cflags = 1;
1360             @cflags_backup = @cflags;
1361             @cflags        = @cflags_noformat;
1362         }
1363
1364         if ($option_buildd) {
1365             $statistics{preprocess}++  if $preprocess;
1366             $statistics{compile}++     if $compile;
1367             $statistics{compile_cpp}++ if $compile_cpp;
1368             $statistics{link}++        if $link;
1369         }
1370
1371         # Check if there are flags indicating a debug build. If that's true,
1372         # skip the check for -O2. This prevents fortification, but that's fine
1373         # for a debug build.
1374         if (any_flags_used($line, @def_cflags_debug)) {
1375             remove_flags([\@cflags], \%flag_renames, $def_cflags[1]);
1376             remove_flags([\@cppflags], \%flag_renames, $def_cppflags_fortify[0]);
1377         }
1378
1379         # Check hardening flags.
1380         my @missing;
1381         if ($compile and (not all_flags_used($line, \@missing, @cflags)
1382                     or (($harden_stack or $harden_stack_strong)
1383                         and cflags_stack_broken($line, \@missing,
1384                                                 $harden_stack_strong)))
1385                 # Libraries linked with -fPIC don't have to (and can't) be
1386                 # linked with -fPIE as well. It's no error if only PIE flags
1387                 # are missing.
1388                 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1389                 # Assume dpkg-buildflags returns the correct flags.
1390                 and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
1391             if (not $option_buildd) {
1392                 error_flags('CFLAGS missing', \@missing, \%flag_renames,
1393                             $input[$i], $input_number[$i]);
1394                 $exit |= $exit_code{flags_missing};
1395             } else {
1396                 $statistics{compile_missing}++;
1397             }
1398         } elsif ($compile_cpp and not all_flags_used($line, \@missing, @cflags)
1399                 # Libraries linked with -fPIC don't have to (and can't) be
1400                 # linked with -fPIE as well. It's no error if only PIE flags
1401                 # are missing.
1402                 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1403                 # Assume dpkg-buildflags returns the correct flags.
1404                 and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
1405             if (not $option_buildd) {
1406                 error_flags('CXXFLAGS missing', \@missing, \%flag_renames,
1407                             $input[$i], $input_number[$i]);
1408                 $exit |= $exit_code{flags_missing};
1409             } else {
1410                 $statistics{compile_cpp_missing}++;
1411             }
1412         }
1413         if ($preprocess
1414                 and (not all_flags_used($line, \@missing, @cppflags)
1415                     # The fortify flag might be overwritten, detect that.
1416                      or ($harden_fortify
1417                          and cppflags_fortify_broken($line, \@missing)))
1418                 # Assume dpkg-buildflags returns the correct flags.
1419                 and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
1420             if (not $option_buildd) {
1421                 error_flags('CPPFLAGS missing', \@missing, \%flag_renames,
1422                             $input[$i], $input_number[$i]);
1423                 $exit |= $exit_code{flags_missing};
1424             } else {
1425                 $statistics{preprocess_missing}++;
1426             }
1427         }
1428         if ($link and not all_flags_used($line, \@missing, @ldflags)
1429                 # Same here, -fPIC conflicts with -fPIE.
1430                 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie)
1431                 # Assume dpkg-buildflags returns the correct flags.
1432                 and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
1433             if (not $option_buildd) {
1434                 error_flags('LDFLAGS missing', \@missing, \%flag_renames,
1435                             $input[$i], $input_number[$i]);
1436                 $exit |= $exit_code{flags_missing};
1437             } else {
1438                 $statistics{link_missing}++;
1439             }
1440         }
1441
1442         # Restore normal CFLAGS.
1443         if ($restore_cflags) {
1444             @cflags = @cflags_backup;
1445         }
1446     }
1447 }
1448
1449 # Print statistics for buildd mode, only output in this mode.
1450 if ($option_buildd) {
1451     my @warning;
1452
1453     if ($statistics{preprocess_missing}) {
1454         push @warning, sprintf 'CPPFLAGS %d (of %d)',
1455                                $statistics{preprocess_missing},
1456                                $statistics{preprocess};
1457     }
1458     if ($statistics{compile_missing}) {
1459         push @warning, sprintf 'CFLAGS %d (of %d)',
1460                                $statistics{compile_missing},
1461                                $statistics{compile};
1462     }
1463     if ($statistics{compile_cpp_missing}) {
1464         push @warning, sprintf 'CXXFLAGS %d (of %d)',
1465                                $statistics{compile_cpp_missing},
1466                                $statistics{compile_cpp};
1467     }
1468     if ($statistics{link_missing}) {
1469         push @warning, sprintf 'LDFLAGS %d (of %d)',
1470                                $statistics{link_missing},
1471                                $statistics{link};
1472     }
1473     if (scalar @warning) {
1474         local $" = ', '; # array join string
1475         print "$buildd_tag{flags_missing}|@warning missing|\n";
1476     }
1477
1478     if ($statistics{commands_nonverbose}) {
1479         printf "$buildd_tag{non_verbose_build}|%d (of %d) hidden|\n",
1480                $statistics{commands_nonverbose},
1481                $statistics{commands},
1482     }
1483 }
1484
1485
1486 exit $exit;
1487
1488
1489 __END__
1490
1491 =head1 NAME
1492
1493 blhc - build log hardening check, checks build logs for missing hardening flags
1494
1495 =head1 SYNOPSIS
1496
1497 B<blhc> [I<options>] I<< <dpkg-buildpackage build log file>.. >>
1498
1499 =head1 DESCRIPTION
1500
1501 blhc is a small tool which checks build logs for missing hardening flags. It's
1502 licensed under the GPL 3 or later.
1503
1504 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
1505 tools using dpkg-buildpackage like pbuilder or sbuild (which is used for the
1506 official buildd build logs)) to help maintainers detect missing hardening
1507 flags in their packages.
1508
1509 Only gcc is detected as compiler at the moment. If other compilers support
1510 hardening flags as well, please report them.
1511
1512 If there's no output, no flags are missing and the build log is fine.
1513
1514 See F<README> for details about performed checks, auto-detection and
1515 limitations.
1516
1517 =head1 OPTIONS
1518
1519 =over 8
1520
1521 =item B<--all>
1522
1523 Force check for all +all (+pie, +bindnow) hardening flags. By default it's
1524 auto detected.
1525
1526 =item B<--arch> I<architecture>
1527
1528 Set the specific architecture (e.g. amd64, armel, etc.), automatically
1529 disables hardening flags not available on this architecture. Is detected
1530 automatically if dpkg-buildpackage is used.
1531
1532 =item B<--bindnow>
1533
1534 Force check for all +bindnow hardening flags. By default it's auto detected.
1535
1536 =item B<--buildd>
1537
1538 Special mode for buildds when automatically parsing log files. The following
1539 changes are in effect:
1540
1541 =over 2
1542
1543 =item *
1544
1545 Print tags instead of normal warnings, see L</"BUILDD TAGS"> for a list of
1546 possible tags.
1547
1548 =item *
1549
1550 Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is
1551 detected).
1552
1553 =item *
1554
1555 Don't require Term::ANSIColor.
1556
1557 =item *
1558
1559 Return exit code 0, unless there was a error (-I, -W messages don't count as
1560 error).
1561
1562 =back
1563
1564 =item B<--debian>
1565
1566 Apply Debian-specific settings. At the moment this only disables checking for
1567 PIE which is automatically applied by Debian's GCC and no longer requires a
1568 compiler command line argument.
1569
1570 =item B<--color>
1571
1572 Use colored (ANSI) output for warning messages.
1573
1574 =item B<--line-numbers>
1575
1576 Display line numbers.
1577
1578 =item B<--ignore-arch> I<arch>
1579
1580 Ignore build logs from architectures matching I<arch>. I<arch> is a string.
1581
1582 Used to prevent false positives. This option can be specified multiple times.
1583
1584 =item B<--ignore-arch-flag> I<arch>:I<flag>
1585
1586 Like B<--ignore-flag>, but only ignore flag on I<arch>.
1587
1588 =item B<--ignore-arch-line> I<arch>:I<line>
1589
1590 Like B<--ignore-line>, but only ignore line on I<arch>.
1591
1592 =item B<--ignore-flag> I<flag>
1593
1594 Don't print an error when the specific flag is missing in a compiler line.
1595 I<flag> is a string.
1596
1597 Used to prevent false positives. This option can be specified multiple times.
1598
1599 =item B<--ignore-line> I<regex>
1600
1601 Ignore lines matching the given Perl regex. I<regex> is automatically anchored
1602 at the beginning and end of the line to prevent false negatives.
1603
1604 B<NOTE>: Not the input lines are checked, but the lines which are displayed in
1605 warnings (which have line continuation resolved).
1606
1607 Used to prevent false positives. This option can be specified multiple times.
1608
1609 =item B<--pie>
1610
1611 Force check for all +pie hardening flags. By default it's auto detected.
1612
1613 =item B<-h -? --help>
1614
1615 Print available options.
1616
1617 =item B<--version>
1618
1619 Print version number and license.
1620
1621 =back
1622
1623 Auto detection for B<--pie> and B<--bindnow> only works if at least one
1624 command uses the required hardening flag (e.g. -fPIE). Then it's required for
1625 all other commands as well.
1626
1627 =head1 EXAMPLES
1628
1629 Normal usage, parse a single log file.
1630
1631     blhc path/to/log/file
1632
1633 If there's no output, no flags are missing and the build log is fine.
1634
1635 Parse multiple log files. The exit code is ORed over all files.
1636
1637     blhc path/to/directory/with/log/files/*
1638
1639 Don't treat missing C<-g> as error:
1640
1641     blhc --ignore-flag -g path/to/log/file
1642
1643 Don't treat missing C<-pie> on kfreebsd-amd64 as error:
1644
1645     blhc --ignore-arch-flag kfreebsd-amd64:-pie path/to/log/file
1646
1647 Ignore lines consisting exactly of C<./script gcc file> which would cause a
1648 false positive.
1649
1650     blhc --ignore-line '\./script gcc file' path/to/log/file
1651
1652 Ignore lines matching C<./script gcc file> somewhere in the line.
1653
1654     blhc --ignore-line '.*\./script gcc file.*' path/to/log/file
1655
1656 Use blhc with pbuilder.
1657
1658     pbuilder path/to/package.dsc | tee path/log/file
1659     blhc path/to/file || echo flags missing
1660
1661 Assume this build log was created on a Debian system and thus don't warn about
1662 missing PIE flags if the current architecture injects them automatically (this
1663 is enabled in buildd mode per default). C<--arch> is necessary if the build
1664 log contains no architecture information as written by dpkg-buildpackage.
1665
1666     blhc --debian --all --arch=amd64 path/to/log/file
1667
1668 =head1 BUILDD TAGS
1669
1670 The following tags are used in I<--buildd> mode. In braces the additional data
1671 which is displayed.
1672
1673 =over 2
1674
1675 =item B<I-hardening-wrapper-used>
1676
1677 The package uses hardening-wrapper which intercepts calls to gcc and adds
1678 hardening flags. The build log doesn't contain any hardening flags and thus
1679 can't be checked by blhc.
1680
1681 =item B<W-compiler-flags-hidden> (summary of hidden lines)
1682
1683 Build log contains lines which hide the real compiler flags. For example:
1684
1685     CC test-a.c
1686     CC test-b.c
1687     CC test-c.c
1688     LD test
1689
1690 Most of the time either C<export V=1> or C<export verbose=1> in
1691 F<debian/rules> fixes builds with hidden compiler flags. Sometimes C<.SILENT>
1692 in a F<Makefile> must be removed. And as last resort the F<Makefile> must be
1693 patched to remove the C<@>s hiding the real compiler commands.
1694
1695 =item B<W-dpkg-buildflags-missing> (summary of missing flags)
1696
1697 CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
1698
1699 =item B<I-invalid-cmake-used> (version)
1700
1701 By default CMake ignores CPPFLAGS thus missing those hardening flags. Debian
1702 patched CMake in versions 2.8.7-1 and 2.8.7-2 to respect CPPFLAGS, but this
1703 patch was rejected by upstream and later reverted in Debian. Thus those two
1704 versions show correct usage of CPPFLAGS even if the package doesn't correctly
1705 handle them (for example by passing them to CFLAGS). To prevent false
1706 negatives just blacklist those two versions.
1707
1708 =item B<I-no-compiler-commands>
1709
1710 No compiler commands were detected. Either the log contains none or they were
1711 not correctly detected by blhc (please report the bug in this case).
1712
1713 =back
1714
1715 =head1 EXIT STATUS
1716
1717 The exit status is a "bit mask", each listed status is ORed when the error
1718 condition occurs to get the result.
1719
1720 =over 4
1721
1722 =item B<0>
1723
1724 Success.
1725
1726 =item B<1>
1727
1728 No compiler commands were found.
1729
1730 =item B<2>
1731
1732 Invalid arguments/options given to blhc.
1733
1734 =item B<4>
1735
1736 Non verbose build.
1737
1738 =item B<8>
1739
1740 Missing hardening flags.
1741
1742 =item B<16>
1743
1744 Hardening wrapper detected, no tests performed.
1745
1746 =item B<32>
1747
1748 Invalid CMake version used. See B<I-invalid-cmake-used> under L</"BUILDD
1749 TAGS"> for a detailed explanation.
1750
1751 =back
1752
1753 =head1 AUTHOR
1754
1755 Simon Ruderich, E<lt>simon@ruderich.orgE<gt>
1756
1757 Thanks to to Bernhard R. Link E<lt>brlink@debian.orgE<gt> and Jaria Alto
1758 E<lt>jari.aalto@cante.netE<gt> for their valuable input and suggestions.
1759
1760 =head1 LICENSE AND COPYRIGHT
1761
1762 Copyright (C) 2012-2020 by Simon Ruderich
1763
1764 This program is free software: you can redistribute it and/or modify
1765 it under the terms of the GNU General Public License as published by
1766 the Free Software Foundation, either version 3 of the License, or
1767 (at your option) any later version.
1768
1769 This program is distributed in the hope that it will be useful,
1770 but WITHOUT ANY WARRANTY; without even the implied warranty of
1771 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1772 GNU General Public License for more details.
1773
1774 You should have received a copy of the GNU General Public License
1775 along with this program.  If not, see <http://www.gnu.org/licenses/>.
1776
1777 =head1 SEE ALSO
1778
1779 L<hardening-check(1)>, L<dpkg-buildflags(1)>
1780
1781 =cut