3 # Build log hardening check, checks build logs for missing hardening flags.
5 # Copyright (C) 2012-2017 Simon Ruderich
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.
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.
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/>.
25 use Text::ParseWords ();
27 our $VERSION = '0.07';
32 # Regex to catch compiler commands.
34 (?<!\s-) # ignore options, e.g. "-c++" [sic!] (used by swig)
35 (?<!\.) # ignore file names, e.g. "test.gcc"
36 (?:cc|gcc|g\+\+|c\+\+|mpicc|mpicxx)
37 (?:-[\d.]+)? # version suffix, e.g. "gcc-4.6"
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)?
44 my $cc_regex_full = qr/
45 (?:$cc_regex_full_prefix-)?
48 # Regex to check if a line contains a compiler command.
49 my $cc_regex_normal = qr/
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: /;
59 # List of source file extensions which require preprocessing.
60 my @source_preprocess_compile_cpp = (
62 qw( cc cp cxx cpp CPP c++ C ),
66 my @source_preprocess_compile = (
72 @source_preprocess_compile_cpp,
74 qw( F FOR fpp FPP FTN F90 F95 F03 F08 ),
76 my @source_preprocess_no_compile = (
80 my @source_preprocess = (
81 @source_preprocess_compile,
82 @source_preprocess_no_compile,
84 # List of source file extensions which don't require preprocessing.
85 my @source_no_preprocess_compile_cpp = (
91 my @source_no_preprocess_compile_ada = (
97 my @source_no_preprocess_compile = (
101 @source_no_preprocess_compile_cpp,
105 qw( f for ftn f90 f95 f03 f08 ),
107 @source_no_preprocess_compile_ada,
109 my @source_no_preprocess_no_compile_ada = (
113 my @source_no_preprocess_no_compile = (
117 @source_no_preprocess_no_compile_ada,
119 my @source_no_preprocess = (
120 @source_no_preprocess_compile,
121 @source_no_preprocess_no_compile,
123 # List of header file extensions which require preprocessing.
124 my @header_preprocess = (
125 # C, C++, Objective-C, Objective-C++
128 qw( hh H hp hxx hpp HPP h++ tcc ),
132 # Normal object files.
134 # Libtool object files.
136 # Dynamic libraries. bzip2 uses .sho.
142 # Hashes for fast extensions lookup to check if a file falls in one of these
144 my %extensions_no_preprocess = map { $_ => 1 } (
145 # There's no @header_no_preprocess.
146 @source_no_preprocess,
148 my %extensions_preprocess = map { $_ => 1 } (
152 my %extensions_compile_link = map { $_ => 1 } (
154 @source_no_preprocess,
156 my %extensions_compile = map { $_ => 1 } (
157 @source_preprocess_compile,
158 @source_no_preprocess_compile,
160 my %extensions_no_compile = map { $_ => 1 } (
161 @source_preprocess_no_compile,
162 @source_no_preprocess_no_compile,
164 my %extensions_compile_cpp = map { $_ => 1 } (
165 @source_preprocess_compile_cpp,
166 @source_no_preprocess_compile_cpp,
168 my %extensions_ada = map { $_ => 1 } (
169 @source_no_preprocess_compile_ada,
170 @source_no_preprocess_no_compile_ada,
172 my %extensions_object = map { $_ => 1 } (
175 my %extension = map { $_ => 1 } (
176 @source_no_preprocess,
182 # Regexp to match file extensions.
183 my $file_extension_regex = qr/
185 \S+ # Filename without extension.
187 ([^\/\\.,;:\s]+)# File extension.
188 (?=\s|\\) # At end of word. Can't use \b because some files have non
189 # word characters at the end and because \b matches double
190 # extensions (like .cpp.o). Works always as all lines are
191 # terminated with "\n".
194 # Expected (hardening) flags. All flags are used as regexps (and compiled to
195 # real regexps below for better execution speed).
198 '-O(?:2|3)', # keep at index 1, search for @def_cflags_debug to change it
200 my @def_cflags_debug = (
201 # These flags indicate a debug build which disables checks for -O2.
205 my @def_cflags_format = (
206 '-Wformat(?:=2)?', # -Wformat=2 implies -Wformat, accept it too
207 '-Werror=format-security', # implies -Wformat-security
209 my @def_cflags_fortify = (
210 # fortify needs at least -O1, but -O2 is recommended anyway
212 my @def_cflags_stack = (
214 '--param[= ]ssp-buffer-size=4',
216 my @def_cflags_stack_strong = (
217 '-fstack-protector-strong',
219 my @def_cflags_pie = (
225 # @def_cxxflags_* is the same as @def_cflags_*.
226 my @def_cppflags = ();
227 my @def_cppflags_fortify = (
228 '-D_FORTIFY_SOURCE=2', # must be first, see cppflags_fortify_broken()
229 # If you add another flag fix hack below (search for "Hack to fix") and
230 # $def_cppflags_fortify[0].
232 my @def_cppflags_fortify_bad = (
233 # These flags may overwrite -D_FORTIFY_SOURCE=2.
235 '-D_FORTIFY_SOURCE=0',
236 '-D_FORTIFY_SOURCE=1',
238 my @def_ldflags = ();
239 my @def_ldflags_relro = (
242 my @def_ldflags_bindnow = (
245 my @def_ldflags_pie = (
249 my @def_ldflags_pic = (
254 # References to all flags checked by the flag checker.
258 \@def_cflags_fortify,
260 \@def_cflags_stack_strong,
264 \@def_cppflags_fortify,
267 \@def_ldflags_bindnow,
270 # References to all used flags.
271 my @flag_refs_all = (
274 \@def_cppflags_fortify_bad,
277 # Renaming rules for the output so the regex parts are not visible. Also
278 # stores string values of flag regexps above, see compile_flag_regexp().
280 '-O(?:2|3)' => '-O2',
281 '-Wformat(?:=2)?' => '-Wformat',
282 '--param[= ]ssp-buffer-size=4' => '--param=ssp-buffer-size=4',
283 '-Wl,(?:-z,)?relro' => '-Wl,-z,relro',
284 '-Wl,(?:-z,)?now' => '-Wl,-z,now',
288 no_compiler_commands => 1 << 0,
289 # used by POD::Usage => 1 << 1,
290 non_verbose_build => 1 << 2,
291 flags_missing => 1 << 3,
292 hardening_wrapper => 1 << 4,
293 invalid_cmake => 1 << 5,
297 no_compiler_commands => 'I-no-compiler-commands',
298 non_verbose_build => 'W-compiler-flags-hidden',
299 flags_missing => 'W-dpkg-buildflags-missing',
300 hardening_wrapper => 'I-hardening-wrapper-used',
301 invalid_cmake => 'I-invalid-cmake-used',
304 # Statistics of missing flags and non-verbose build commands. Used for
308 preprocess_missing => 0,
310 compile_missing => 0,
312 compile_cpp_missing => 0,
316 commands_nonverbose => 0,
319 # Use colored (ANSI) output?
325 # Only works for single-level arrays with no undef values. Thanks to perlfaq4.
327 my ($first_ref, $second_ref) = @_;
329 return 0 if scalar @{$first_ref} != scalar @{$second_ref};
331 my $length = scalar @{$first_ref};
332 for (my $i = 0; $i < $length; $i++) {
333 return 0 if $first_ref->[$i] ne $second_ref->[$i];
340 my ($message, $missing_flags_ref, $flag_renames_ref, $line) = @_;
342 # Get string value of qr//-escaped regexps and if requested rename them.
343 my @missing_flags = map {
344 $flag_renames_ref->{$_}
345 } @{$missing_flags_ref};
347 my $flags = join ' ', @missing_flags;
348 printf '%s (%s)%s %s',
349 error_color($message, 'red'), $flags, error_color(':', 'yellow'),
354 sub error_non_verbose_build {
358 error_color('NONVERBOSE BUILD', 'red'),
359 error_color(':', 'yellow'),
364 sub error_invalid_cmake {
368 error_color('INVALID CMAKE', 'red'),
369 error_color(':', 'yellow'),
374 sub error_hardening_wrapper {
376 error_color('HARDENING WRAPPER', 'red'),
377 error_color(':', 'yellow'),
378 'no checks possible, aborting';
383 my ($message, $color) = @_;
386 return Term::ANSIColor::colored($message, $color);
393 my ($line, @flags) = @_;
395 foreach my $flag (@flags) {
396 return 1 if $line =~ /$flag/;
402 my ($line, $missing_flags_ref, @flags) = @_;
404 my @missing_flags = ();
405 foreach my $flag (@flags) {
406 if (not $line =~ /$flag/) {
407 push @missing_flags, $flag;
411 return 1 if scalar @missing_flags == 0;
413 @{$missing_flags_ref} = @missing_flags;
417 sub cppflags_fortify_broken {
418 my ($line, $missing_flags) = @_;
420 # This doesn't take the position into account, but is a simple solution.
421 # And if the build system tries to force -D_FORTIFY_SOURCE=0/1, something
424 if (any_flags_used($line, @def_cppflags_fortify_bad)) {
425 # $def_cppflags_fortify[0] must be -D_FORTIFY_SOURCE=2!
426 push @{$missing_flags}, $def_cppflags_fortify[0];
433 # Modifies $missing_flags_ref array.
434 sub pic_pie_conflict {
435 my ($line, $pie, $missing_flags_ref, @flags_pie) = @_;
437 return 0 if not $pie;
438 return 0 if not any_flags_used($line, @def_ldflags_pic);
440 my %flags = map { $_ => 1 } @flags_pie;
442 # Remove all PIE flags from @missing_flags as they are not required with
445 not exists $flags{$_}
446 } @{$missing_flags_ref};
447 @{$missing_flags_ref} = @result;
449 # We got a conflict when no flags are left, thus only PIE flags were
450 # missing. If other flags were missing abort because the conflict is not
452 return scalar @result == 0;
455 sub is_non_verbose_build {
456 my ($line, $skip_ref, $input_ref, $line_offset, $line_count) = @_;
458 if ($line =~ /$libtool_regex/o) {
459 # libtool's --silent hides the real compiler flags.
460 if ($line =~ /\s--silent/) {
462 # If --silent is not present, skip this line as some compiler flags
463 # might be missing (e.g. -fPIE) which are handled correctly by libtool
464 # internally. libtool displays the real compiler command on the next
465 # line, so the flags are checked as usual.
472 if (not (index($line, 'checking if you want to see long compiling messages... no') == 0
473 or $line =~ /^\s*\[?(?:CC|CCLD|C\+\+|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/
474 or $line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
475 or $line =~ /^\s*[Bb]uilding (?:program|shared library)\s+(.+?)$/
476 or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
482 # C++ compiler setting.
483 return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
484 return 0 if $line =~ /^\s*C\+\+ Library: stdc\+\+$/;
485 # "Compiling" non binary files.
486 return 0 if $line =~ /^\s*Compiling \S+\.(?:py|el)['"]?\s*(?:\.\.\.)?$/;
487 # "Compiling" with no file name.
488 if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) {
489 # $file_extension_regex may need spaces around the filename.
490 return 0 if not " $1 " =~ /$file_extension_regex/o;
495 # On the first pass we only check if this line is verbose or not.
496 return 1 if not defined $input_ref;
498 # Second pass, we have access to the next lines.
501 # CMake and other build systems print the non-verbose messages also when
502 # building verbose. If a compiler and the file name occurs in the next
503 # lines, treat it as verbose build.
505 # Get filename, we can't use the complete path as only parts of it are
506 # used in the real compiler command.
507 $file =~ m{/([^/\s]+)$};
510 for (my $i = 1; $i <= $line_count; $i++) {
511 my $next_line = $input_ref->[$line_offset + $i];
512 last unless defined $next_line;
514 if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
515 # Not a non-verbose line, but we still have to skip the
516 # current line as it doesn't contain any compiler commands.
526 # Remove @flags from $flag_refs_ref, uses $flag_renames_ref as reference.
528 my ($flag_refs_ref, $flag_renames_ref, @flags) = @_;
530 my %removes = map { $_ => 1 } @flags;
531 foreach my $flags (@{$flag_refs_ref}) {
533 # Flag found as string.
534 not exists $removes{$_}
535 # Flag found as string representation of regexp.
536 and (not defined $flag_renames_ref->{$_}
537 or not exists $removes{$flag_renames_ref->{$_}})
544 # Modifies $flag_renames_ref hash.
545 sub compile_flag_regexp {
546 my ($flag_renames_ref, @flags) = @_;
549 foreach my $flag (@flags) {
550 # Compile flag regexp for faster execution.
551 my $regex = qr/\s$flag(?:\s|\\)/;
553 # Store flag name in replacement string for correct flags in messages
554 # with qr//ed flag regexps.
555 $flag_renames_ref->{$regex}
556 = (exists $flag_renames_ref->{$flag})
557 ? $flag_renames_ref->{$flag}
560 push @result, $regex;
565 # Does any extension in @extensions exist in %{$extensions_ref}?
566 sub extension_found {
567 my ($extensions_ref, @extensions) = @_;
569 foreach my $extension (@extensions) {
570 if (exists $extensions_ref->{$extension}) {
580 # Parse command line arguments.
582 my $option_version = 0;
584 my $option_bindnow = 0;
585 my @option_ignore_arch = ();
586 my @option_ignore_flag = ();
587 my @option_ignore_arch_flag = ();
588 my @option_ignore_line = ();
589 my @option_ignore_arch_line = ();
591 my $option_arch = undef;
592 my $option_buildd = 0;
594 if (not Getopt::Long::GetOptions(
595 'help|h|?' => \$option_help,
596 'version' => \$option_version,
598 'pie' => \$option_pie,
599 'bindnow' => \$option_bindnow,
600 'all' => \$option_all,
602 'ignore-arch=s' => \@option_ignore_arch,
603 'ignore-flag=s' => \@option_ignore_flag,
604 'ignore-arch-flag=s' => \@option_ignore_arch_flag,
605 'ignore-line=s' => \@option_ignore_line,
606 'ignore-arch-line=s' => \@option_ignore_arch_line,
608 'color' => \$option_color,
609 'arch=s' => \$option_arch,
610 'buildd' => \$option_buildd,
613 Pod::Usage::pod2usage(2);
617 Pod::Usage::pod2usage(1);
619 if ($option_version) {
621 blhc $VERSION Copyright (C) 2012-2017 Simon Ruderich
623 This program is free software: you can redistribute it and/or modify
624 it under the terms of the GNU General Public License as published by
625 the Free Software Foundation, either version 3 of the License, or
626 (at your option) any later version.
628 This program is distributed in the hope that it will be useful,
629 but WITHOUT ANY WARRANTY; without even the implied warranty of
630 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
631 GNU General Public License for more details.
633 You should have received a copy of the GNU General Public License
634 along with this program. If not, see <http://www.gnu.org/licenses/>.
640 if (scalar @ARGV == 0) {
642 Pod::Usage::pod2usage(2);
645 # Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not
646 # installed on Debian's buildds.
647 if (not $option_buildd) {
648 require Term::ANSIColor;
656 # Precompiled ignores for faster lookup.
657 my %option_ignore_arch_flag = ();
658 my %option_ignore_arch_line = ();
660 # Strip flags which should be ignored.
661 if (scalar @option_ignore_flag > 0) {
662 remove_flags(\@flag_refs, \%flag_renames, @option_ignore_flag);
664 # Same for arch specific ignore flags, but only prepare here.
665 if (scalar @option_ignore_arch_flag > 0) {
666 foreach my $ignore (@option_ignore_arch_flag) {
667 my ($ignore_arch, $ignore_flag) = split /:/, $ignore, 2;
669 if (not $ignore_arch or not $ignore_flag) {
670 printf STDERR 'Value "%s" invalid for option ignore-arch-flag '
671 . '("arch:flag" expected)' . "\n", $ignore;
673 Pod::Usage::pod2usage(2);
676 push @{$option_ignore_arch_flag{$ignore_arch}}, $ignore_flag;
680 # Precompile all flag regexps. any_flags_used(), all_flags_used() get a lot
682 foreach my $flags (@flag_refs_all) {
683 @{$flags} = compile_flag_regexp(\%flag_renames, @{$flags});
686 # Precompile ignore line regexps, also anchor at beginning and end of line.
687 foreach my $ignore (@option_ignore_line) {
688 $ignore = qr/^$ignore$/;
690 # Same for arch specific ignore lines.
691 if (scalar @option_ignore_arch_line > 0) {
692 foreach my $ignore (@option_ignore_arch_line) {
693 my ($ignore_arch, $ignore_line) = split /:/, $ignore, 2;
695 if (not $ignore_arch or not $ignore_line) {
696 printf STDERR 'Value "%s" invalid for option ignore-arch-line '
697 . '("arch:line" expected)' . "\n", $ignore;
699 Pod::Usage::pod2usage(2);
702 push @{$option_ignore_arch_line{$ignore_arch}}, qr/^$ignore_line$/;
710 foreach my $file (@ARGV) {
711 print "checking '$file'...\n" if scalar @ARGV > 1;
713 -f $file or die "No such file: $file";
715 open my $fh, '<', $file or die $!;
717 # Architecture of this file.
718 my $arch = $option_arch;
720 # Hardening options. Not all architectures support all hardening options.
721 my $harden_format = 1;
722 my $harden_fortify = 1;
723 my $harden_stack = 1;
724 my $harden_stack_strong = 1;
725 my $harden_relro = 1;
726 my $harden_bindnow = $option_bindnow; # defaults to 0
727 my $harden_pie = $option_pie; # defaults to 0
729 # Does this build log use ada? Ada also uses gcc as compiler but uses
730 # different CFLAGS. But only perform ada checks if an ada compiler is used
731 # for performance reasons.
734 # Number of parallel jobs to prevent false positives when detecting
735 # non-verbose builds. As not all jobs declare the number of parallel jobs
736 # use a large enough default.
739 while (my $line = <$fh>) {
740 # Detect architecture automatically unless overridden. For buildd logs
741 # only, doesn't use the dpkg-buildpackage header. Necessary to ignore
742 # build logs which aren't built (wrong architecture, build error,
745 if (index($line, 'Build Architecture: ') == 0) {
746 $arch = substr $line, 20, -1; # -1 to ignore '\n' at the end
747 # For old logs (sbuild << 0.63.0-1).
748 } elsif (index($line, 'Architecture: ') == 0) {
749 $arch = substr $line, 14, -1; # -1 to ignore '\n' at the end
753 # dpkg-buildflags only provides hardening flags since 1.16.1, don't
754 # check for hardening flags in buildd mode if an older dpkg-dev is
755 # used. Default flags (-g -O2) are still checked.
757 # Packages which were built before 1.16.1 but used their own hardening
758 # flags are not checked.
760 # Strong stack protector is used since dpkg 1.17.11.
762 and index($line, 'Toolchain package versions: ') == 0) {
763 require Dpkg::Version;
766 my $disable_strong = 1;
768 if ($line =~ /\bdpkg-dev_(\S+)/) {
769 if (Dpkg::Version::version_compare($1, '1.16.1') >= 0) {
772 if (Dpkg::Version::version_compare($1, '1.17.11') >= 0) {
785 if ($disable_strong) {
786 $harden_stack_strong = 0;
790 # The following two versions of CMake in Debian obeyed CPPFLAGS, but
791 # this was later dropped because upstream rejected the patch. Thus
792 # build logs with these versions will have fortify hardening flags
793 # enabled, even though they may be not correctly set and are missing
794 # when build with later CMake versions. Thanks to Aron Xu for letting
796 if (index($line, 'Package versions: ') == 0
797 and $line =~ /\bcmake_(\S+)/
798 and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
799 if (not $option_buildd) {
800 error_invalid_cmake($1);
801 $exit |= $exit_code{invalid_cmake};
803 print "$buildd_tag{invalid_cmake}|$1|\n";
807 # Debian's build daemons use "Filtered Build-Depends:" (or just
808 # "Build-Depends:" in older versions) for the build dependencies, but
809 # pbuilder uses "Depends:"; support both.
810 if (index($line, 'Filtered Build-Depends: ') == 0
811 or index($line, 'Build-Depends: ') == 0
812 or index($line, 'Depends: ') == 0) {
813 # If hardening wrapper is used (wraps calls to gcc and adds
814 # hardening flags automatically) we can't perform any checks,
816 if ($line =~ /\bhardening-wrapper\b/) {
817 if (not $option_buildd) {
818 error_hardening_wrapper();
819 $exit |= $exit_code{hardening_wrapper};
821 print "$buildd_tag{hardening_wrapper}||\n";
827 if ($line =~ /\bgnat\b/) {
832 # This flags is not always available, but if it is use it.
833 if ($line =~ /^DEB_BUILD_OPTIONS=.*\bparallel=(\d+)/) {
837 # We skip over unimportant lines at the beginning of the log to
838 # prevent false positives.
839 last if index($line, 'dpkg-buildpackage: ') == 0;
842 # Input lines, contain only the lines with compiler commands.
844 # Non-verbose lines in the input. Used to reduce calls to
845 # is_non_verbose_build() (which is quite slow) in the second loop when
846 # it's already clear if a line is non-verbose or not.
847 my @input_nonverbose = ();
849 my $continuation = 0;
850 my $complete_line = undef;
852 while (my $line = <$fh>) {
853 # And stop at the end of the build log. Package details (reported by
854 # the buildd logs) are not important for us. This also prevents false
856 last if index($line, 'Build finished at ') == 0
857 and $line =~ /^Build finished at \d{8}-\d{4}$/;
859 if (not $continuation) {
863 # Detect architecture automatically unless overridden.
865 and index($line, 'dpkg-buildpackage: host architecture ') == 0) {
866 $arch = substr $line, 37, -1; # -1 to ignore '\n' at the end
868 # Old buildd logs use e.g. "host architecture is alpha", remove
869 # the "is", otherwise debarch_to_debtriplet() will not detect the
871 if (index($arch, 'is ') == 0) {
872 $arch = substr $arch, 3;
876 next if $line =~ /^\s*#/;
877 # Ignore compiler warnings for now.
878 next if $line =~ /$warning_regex/o;
880 if (not $option_buildd and index($line, "\033") != -1) { # \033 = esc
881 # Remove all ANSI color sequences which are sometimes used in
882 # non-verbose builds.
883 $line = Term::ANSIColor::colorstrip($line);
884 # Also strip '\0xf' (delete previous character), used by Elinks'
887 # And "ESC(B" which seems to be used on armhf and hurd (not sure
889 $line =~ s/\033\(B//g;
892 # Check if this line indicates a non verbose build.
894 $non_verbose |= is_non_verbose_build($line, \$skip);
897 # One line may contain multiple commands (";"). Treat each one as
898 # single line. parse_line() is slow, only use it when necessary.
899 my @line = (index($line, ';') == -1)
902 # Ensure newline at the line end - necessary for
903 # correct parsing later.
906 } Text::ParseWords::parse_line(';', 1, $line);
907 foreach my $line (@line) {
911 # Join lines, but leave the "\" in place so it's clear where
912 # the original line break was.
913 chomp $complete_line;
914 $complete_line .= ' ' . $line;
916 # Line continuation, line ends with "\".
917 if ($line =~ /\\$/) {
919 # Start line continuation.
920 if (not defined $complete_line) {
921 $complete_line = $line;
926 # Use the complete line if a line continuation occurred.
927 if (defined $complete_line) {
928 $line = $complete_line;
929 $complete_line = undef;
932 # Ignore lines with no compiler commands.
933 next if not $non_verbose
934 and not $line =~ /$cc_regex_normal/o;
935 # Ignore lines with no filenames with extensions. May miss some
936 # non-verbose builds (e.g. "gcc -o test" [sic!]), but shouldn't be
937 # a problem as the log will most likely contain other non-verbose
938 # commands which are detected.
939 next if not $non_verbose
940 and not $line =~ /$file_extension_regex/o;
942 # Ignore false positives.
944 # `./configure` output.
945 next if not $non_verbose
946 and $line =~ /^(?:checking|[Cc]onfigure:) /;
947 next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
948 [Cc]ompiler[\s.]*:?\s+
950 next if $line =~ m{^\s*(?:-\s)?(?:HOST_)?(?:CC|CXX)
951 \s*=\s*$cc_regex_full
952 # optional compiler options, don't allow
953 # "everything" here to prevent false negatives
954 \s*(?:\s-\S+)*\s*$}xo;
955 # `moc-qt4`/`moc-qt5` contain '-I.../linux-g++' in their command
956 # line (or similar for other architectures) which gets recognized
957 # as a compiler line, but `moc-qt*` is only a preprocessor for Qt
958 # C++ files. No hardening flags are relevant during this step,
959 # thus ignore `moc-qt*` lines. The resulting files will be
960 # compiled in a separate step (and therefore checked).
961 next if $line =~ m{^\S+/bin/moc(?:-qt[45])?
963 -I\S+/mkspecs/[a-z]+-g\++(?:-64)?
965 # Ignore false positives when the line contains only CC=gcc but no
967 if ($line =~ /(.*)CC=$cc_regex_full(.*)/o) {
970 next if not $before =~ /$cc_regex_normal/o
971 and not $after =~ /$cc_regex_normal/o;
973 # Ignore false positives caused by gcc -v. It outputs a line
974 # looking like a normal compiler line but which is sometimes
975 # missing hardening flags, although the normal compiler line
977 next if $line =~ m{^\s+/usr/lib/gcc/$cc_regex_full_prefix/
978 [0-9.]+/cc1(?:plus)?}xo;
979 # Ignore false positive with `rm` which may remove files which
980 # look like a compiler executable thus causing the line to be
981 # treated as a normal compiler line.
982 next if $line =~ m{^\s*rm\s+};
983 # Some build systems emit "gcc > file".
984 next if $line =~ m{$cc_regex_normal\s*>\s*\S+};
986 # Check if additional hardening options were used. Used to ensure
987 # they are used for the complete build.
988 $harden_pie = 1 if any_flags_used($line, @def_cflags_pie,
990 $harden_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
993 push @input_nonverbose, $non_verbose;
999 # Ignore arch if requested.
1000 if (scalar @option_ignore_arch > 0 and $arch) {
1001 foreach my $ignore (@option_ignore_arch) {
1002 if ($arch eq $ignore) {
1003 print "ignoring architecture '$arch'\n";
1009 if (scalar @input == 0) {
1010 if (not $option_buildd) {
1011 print "No compiler commands!\n";
1012 $exit |= $exit_code{no_compiler_commands};
1014 print "$buildd_tag{no_compiler_commands}||\n";
1019 if ($option_buildd) {
1020 $statistics{commands} += scalar @input;
1023 # Option or auto detected.
1025 # The following was partially copied from dpkg-dev 1.18.15
1026 # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, _add_hardening_flags()),
1027 # copyright Raphaël Hertzog <hertzog@debian.org>, Kees Cook
1028 # <kees@debian.org>, Canonical, Ltd. licensed under GPL version 2 or
1029 # later. Keep it in sync.
1033 # Recent dpkg versions use a quadruplet for arch. Support both.
1035 (undef, undef, $os, $cpu) = Dpkg::Arch::debarch_to_debtuple($arch);
1038 (undef, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
1041 # Disable unsupported hardening options.
1042 if ($os !~ /^(?:linux|kfreebsd|knetbsd|hurd)$/
1043 or $cpu =~ /^(?:hppa|avr32)$/) {
1046 if ($cpu =~ /^(?:ia64|alpha|hppa|nios2)$/ or $arch eq 'arm') {
1048 $harden_stack_strong = 0;
1050 if ($cpu =~ /^(?:ia64|hppa|avr32)$/) {
1052 $harden_bindnow = 0;
1057 my @cflags = @def_cflags;
1058 my @cxxflags = @def_cxxflags;
1059 my @cppflags = @def_cppflags;
1060 my @ldflags = @def_ldflags;
1061 # Check the specified hardening options, same order as dpkg-buildflags.
1063 @cflags = (@cflags, @def_cflags_pie);
1064 @cxxflags = (@cxxflags, @def_cflags_pie);
1065 @ldflags = (@ldflags, @def_ldflags_pie);
1067 if ($harden_stack_strong) {
1068 @cflags = (@cflags, @def_cflags_stack_strong);
1069 @cxxflags = (@cxxflags, @def_cflags_stack_strong);
1070 } elsif ($harden_stack) {
1071 @cflags = (@cflags, @def_cflags_stack);
1072 @cxxflags = (@cxxflags, @def_cflags_stack);
1074 if ($harden_fortify) {
1075 @cflags = (@cflags, @def_cflags_fortify);
1076 @cxxflags = (@cxxflags, @def_cflags_fortify);
1077 @cppflags = (@cppflags, @def_cppflags_fortify);
1079 if ($harden_format) {
1080 @cflags = (@cflags, @def_cflags_format);
1081 @cxxflags = (@cxxflags, @def_cflags_format);
1083 if ($harden_relro) {
1084 @ldflags = (@ldflags, @def_ldflags_relro);
1086 if ($harden_bindnow) {
1087 @ldflags = (@ldflags, @def_ldflags_bindnow);
1090 # Ada doesn't support format hardening flags, see #680117 for more
1091 # information. Filter them out if ada is used.
1093 my @cflags_noformat;
1094 if ($ada and $harden_format) {
1095 @cflags_noformat = grep {
1097 foreach my $flag (@def_cflags_format) {
1098 $ok = 0 if $_ eq $flag;
1104 # Hack to fix cppflags_fortify_broken() if --ignore-flag
1105 # -D_FORTIFY_SOURCE=2 is used to ignore missing fortification. Only works
1106 # as long as @def_cppflags_fortify contains only one variable.
1107 if (scalar @def_cppflags_fortify == 0) {
1108 $harden_fortify = 0;
1111 # Ignore flags for this arch if requested.
1112 if ($arch and exists $option_ignore_arch_flag{$arch}) {
1113 my @local_flag_refs = (\@cflags, \@cxxflags, \@cppflags, \@ldflags);
1115 remove_flags(\@local_flag_refs,
1117 @{$option_ignore_arch_flag{$arch}});
1120 my @ignore_line = @option_ignore_line;
1121 # Ignore lines for this arch if requested.
1122 if ($arch and exists $option_ignore_arch_line{$arch}) {
1123 @ignore_line = (@ignore_line, @{$option_ignore_arch_line{$arch}});
1127 for (my $i = 0; $i < scalar @input; $i++) {
1128 my $line = $input[$i];
1130 # Ignore line if requested.
1131 foreach my $ignore (@ignore_line) {
1132 next LINE if $line =~ /$ignore/;
1136 if ($input_nonverbose[$i]
1137 and is_non_verbose_build($line, \$skip,
1138 \@input, $i, $parallel)) {
1139 if (not $option_buildd) {
1140 error_non_verbose_build($line);
1141 $exit |= $exit_code{non_verbose_build};
1143 $statistics{commands_nonverbose}++;
1147 # Even if it's a verbose build, we might have to skip this line (see
1148 # is_non_verbose_build()).
1151 my $orig_line = $line;
1153 # Remove everything until and including the compiler command. Makes
1154 # checks easier and faster.
1155 $line =~ s/^.*?$cc_regex//o;
1156 # "([...] test.c)" is not detected as 'test.c' - fix this by removing
1157 # the brace and similar characters at the line end.
1158 $line =~ s/['")]+$//;
1160 # Skip unnecessary tests when only preprocessing.
1161 my $flag_preprocess = 0;
1168 # Preprocess, compile, assemble.
1169 if ($line =~ /\s(-E|-S|-c)\b/) {
1171 $flag_preprocess = 1 if $1 eq '-E';
1172 $compile = 1 if $1 eq '-S' or $1 eq '-c';
1173 # Dependency generation for Makefiles. The other flags (-MF -MG -MP
1174 # -MT -MQ) are always used with -M/-MM.
1175 } elsif ($line =~ /\s(?:-M|-MM)\b/) {
1177 # Otherwise assume we are linking.
1182 # -MD/-MMD also cause dependency generation, but they don't imply -E!
1183 if ($line =~ /\s(?:-MD|-MMD)\b/) {
1185 $flag_preprocess = 0;
1188 # Dependency generation for Makefiles, no preprocessing or other flags
1190 next if $dependency;
1192 # Get all file extensions on this line.
1193 my @extensions = $line =~ /$file_extension_regex/go;
1194 # Ignore all unknown extensions to speedup the search below.
1195 @extensions = grep { exists $extension{$_} } @extensions;
1197 # These file types don't require preprocessing.
1198 if (extension_found(\%extensions_no_preprocess, @extensions)) {
1201 # These file types require preprocessing.
1202 if (extension_found(\%extensions_preprocess, @extensions)) {
1203 # Prevent false positives with "libtool: link: g++ -include test.h
1204 # .." compiler lines.
1205 if ($orig_line !~ /$libtool_link_regex/o) {
1210 if (not $flag_preprocess) {
1211 # If there are source files then it's compiling/linking in one
1212 # step and we must check both. We only check for source files
1213 # here, because header files cause too many false positives.
1214 if (extension_found(\%extensions_compile_link, @extensions)) {
1215 # Assembly files don't need CFLAGS.
1216 if (not extension_found(\%extensions_compile, @extensions)
1217 and extension_found(\%extensions_no_compile, @extensions)) {
1219 # But the rest does.
1223 # No compilable extensions found, either linking or compiling
1226 # If there are also no object files we are just compiling headers
1227 # (.h -> .h.gch). Don't check for linker flags in this case. Due
1228 # to our liberal checks for compiler lines, this also reduces the
1229 # number of false positives considerably.
1231 and not extension_found(\%extensions_object, @extensions)) {
1236 my $compile_cpp = 0;
1237 my $restore_cflags = 0;
1238 # Assume CXXFLAGS are required when a C++ file is specified in the
1241 and extension_found(\%extensions_compile_cpp, @extensions)) {
1244 # Ada needs special CFLAGS, use them if only ada files are compiled.
1246 and extension_found(\%extensions_ada, @extensions)) {
1247 $restore_cflags = 1;
1248 $preprocess = 0; # Ada uses no CPPFLAGS
1249 @cflags_backup = @cflags;
1250 @cflags = @cflags_noformat;
1253 if ($option_buildd) {
1254 $statistics{preprocess}++ if $preprocess;
1255 $statistics{compile}++ if $compile;
1256 $statistics{compile_cpp}++ if $compile_cpp;
1257 $statistics{link}++ if $link;
1260 # Check if there are flags indicating a debug build. If that's true,
1261 # skip the check for -O2. This prevents fortification, but that's fine
1262 # for a debug build.
1263 if (any_flags_used($line, @def_cflags_debug)) {
1264 remove_flags([\@cflags], \%flag_renames, $def_cflags[1]);
1265 remove_flags([\@cppflags], \%flag_renames, $def_cppflags_fortify[0]);
1268 # Check hardening flags.
1270 if ($compile and not all_flags_used($line, \@missing, @cflags)
1271 # Libraries linked with -fPIC don't have to (and can't) be
1272 # linked with -fPIE as well. It's no error if only PIE flags
1274 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1275 # Assume dpkg-buildflags returns the correct flags.
1276 and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
1277 if (not $option_buildd) {
1278 error_flags('CFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1279 $exit |= $exit_code{flags_missing};
1281 $statistics{compile_missing}++;
1283 } elsif ($compile_cpp and not all_flags_used($line, \@missing, @cflags)
1284 # Libraries linked with -fPIC don't have to (and can't) be
1285 # linked with -fPIE as well. It's no error if only PIE flags
1287 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1288 # Assume dpkg-buildflags returns the correct flags.
1289 and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
1290 if (not $option_buildd) {
1291 error_flags('CXXFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1292 $exit |= $exit_code{flags_missing};
1294 $statistics{compile_cpp_missing}++;
1298 and (not all_flags_used($line, \@missing, @cppflags)
1299 # The fortify flag might be overwritten, detect that.
1301 and cppflags_fortify_broken($line, \@missing)))
1302 # Assume dpkg-buildflags returns the correct flags.
1303 and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
1304 if (not $option_buildd) {
1305 error_flags('CPPFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1306 $exit |= $exit_code{flags_missing};
1308 $statistics{preprocess_missing}++;
1311 if ($link and not all_flags_used($line, \@missing, @ldflags)
1312 # Same here, -fPIC conflicts with -fPIE.
1313 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie)
1314 # Assume dpkg-buildflags returns the correct flags.
1315 and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
1316 if (not $option_buildd) {
1317 error_flags('LDFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1318 $exit |= $exit_code{flags_missing};
1320 $statistics{link_missing}++;
1324 # Restore normal CFLAGS.
1325 if ($restore_cflags) {
1326 @cflags = @cflags_backup;
1331 # Print statistics for buildd mode, only output in this mode.
1332 if ($option_buildd) {
1335 if ($statistics{preprocess_missing}) {
1336 push @warning, sprintf 'CPPFLAGS %d (of %d)',
1337 $statistics{preprocess_missing},
1338 $statistics{preprocess};
1340 if ($statistics{compile_missing}) {
1341 push @warning, sprintf 'CFLAGS %d (of %d)',
1342 $statistics{compile_missing},
1343 $statistics{compile};
1345 if ($statistics{compile_cpp_missing}) {
1346 push @warning, sprintf 'CXXFLAGS %d (of %d)',
1347 $statistics{compile_cpp_missing},
1348 $statistics{compile_cpp};
1350 if ($statistics{link_missing}) {
1351 push @warning, sprintf 'LDFLAGS %d (of %d)',
1352 $statistics{link_missing},
1355 if (scalar @warning) {
1356 local $" = ', '; # array join string
1357 print "$buildd_tag{flags_missing}|@warning missing|\n";
1360 if ($statistics{commands_nonverbose}) {
1361 printf "$buildd_tag{non_verbose_build}|%d (of %d) hidden|\n",
1362 $statistics{commands_nonverbose},
1363 $statistics{commands},
1375 blhc - build log hardening check, checks build logs for missing hardening flags
1379 B<blhc> [I<options>] I<< <dpkg-buildpackage build log file>.. >>
1383 blhc is a small tool which checks build logs for missing hardening flags. It's
1384 licensed under the GPL 3 or later.
1386 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
1387 tools using dpkg-buildpackage like pbuilder or sbuild (which is used for the
1388 official buildd build logs)) to help maintainers detect missing hardening
1389 flags in their packages.
1391 Only gcc is detected as compiler at the moment. If other compilers support
1392 hardening flags as well, please report them.
1394 If there's no output, no flags are missing and the build log is fine.
1396 See F<README> for details about performed checks, auto-detection and
1405 Force check for all +all (+pie, +bindnow) hardening flags. By default it's
1408 =item B<--arch> I<architecture>
1410 Set the specific architecture (e.g. amd64, armel, etc.), automatically
1411 disables hardening flags not available on this architecture. Is detected
1412 automatically if dpkg-buildpackage is used.
1416 Force check for all +bindnow hardening flags. By default it's auto detected.
1420 Special mode for buildds when automatically parsing log files. The following
1421 changes are in effect:
1427 Print tags instead of normal warnings, see L</"BUILDD TAGS"> for a list of
1432 Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is
1437 Don't require Term::ANSIColor.
1441 Return exit code 0, unless there was a error (-I, -W messages don't count as
1448 Use colored (ANSI) output for warning messages.
1450 =item B<--ignore-arch> I<arch>
1452 Ignore build logs from architectures matching I<arch>. I<arch> is a string.
1454 Used to prevent false positives. This option can be specified multiple times.
1456 =item B<--ignore-arch-flag> I<arch>:I<flag>
1458 Like B<--ignore-flag>, but only ignore flag on I<arch>.
1460 =item B<--ignore-arch-line> I<arch>:I<line>
1462 Like B<--ignore-line>, but only ignore line on I<arch>.
1464 =item B<--ignore-flag> I<flag>
1466 Don't print an error when the specific flag is missing in a compiler line.
1467 I<flag> is a string.
1469 Used to prevent false positives. This option can be specified multiple times.
1471 =item B<--ignore-line> I<regex>
1473 Ignore lines matching the given Perl regex. I<regex> is automatically anchored
1474 at the beginning and end of the line to prevent false negatives.
1476 B<NOTE>: Not the input lines are checked, but the lines which are displayed in
1477 warnings (which have line continuation resolved).
1479 Used to prevent false positives. This option can be specified multiple times.
1483 Force check for all +pie hardening flags. By default it's auto detected.
1485 =item B<-h -? --help>
1487 Print available options.
1491 Print version number and license.
1495 Auto detection for B<--pie> and B<--bindnow> only works if at least one
1496 command uses the required hardening flag (e.g. -fPIE). Then it's required for
1497 all other commands as well.
1501 Normal usage, parse a single log file.
1503 blhc path/to/log/file
1505 If there's no output, no flags are missing and the build log is fine.
1507 Parse multiple log files. The exit code is ORed over all files.
1509 blhc path/to/directory/with/log/files/*
1511 Don't treat missing C<-g> as error:
1513 blhc --ignore-flag -g path/to/log/file
1515 Don't treat missing C<-pie> on kfreebsd-amd64 as error:
1517 blhc --ignore-arch-flag kfreebsd-amd64:-pie path/to/log/file
1519 Ignore lines consisting exactly of C<./script gcc file> which would cause a
1522 blhc --ignore-line '\./script gcc file' path/to/log/file
1524 Ignore lines matching C<./script gcc file> somewhere in the line.
1526 blhc --ignore-line '.*\./script gcc file.*' path/to/log/file
1528 Use blhc with pbuilder.
1530 pbuilder path/to/package.dsc | tee path/log/file
1531 blhc path/to/file || echo flags missing
1535 The following tags are used in I<--buildd> mode. In braces the additional data
1540 =item B<I-hardening-wrapper-used>
1542 The package uses hardening-wrapper which intercepts calls to gcc and adds
1543 hardening flags. The build log doesn't contain any hardening flags and thus
1544 can't be checked by blhc.
1546 =item B<W-compiler-flags-hidden> (summary of hidden lines)
1548 Build log contains lines which hide the real compiler flags. For example:
1555 Most of the time either C<export V=1> or C<export verbose=1> in
1556 F<debian/rules> fixes builds with hidden compiler flags. Sometimes C<.SILENT>
1557 in a F<Makefile> must be removed. And as last resort the F<Makefile> must be
1558 patched to remove the C<@>s hiding the real compiler commands.
1560 =item B<W-dpkg-buildflags-missing> (summary of missing flags)
1562 CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
1564 =item B<I-invalid-cmake-used> (version)
1566 By default CMake ignores CPPFLAGS thus missing those hardening flags. Debian
1567 patched CMake in versions 2.8.7-1 and 2.8.7-2 to respect CPPFLAGS, but this
1568 patch was rejected by upstream and later reverted in Debian. Thus those two
1569 versions show correct usage of CPPFLAGS even if the package doesn't correctly
1570 handle them (for example by passing them to CFLAGS). To prevent false
1571 negatives just blacklist those two versions.
1573 =item B<I-no-compiler-commands>
1575 No compiler commands were detected. Either the log contains none or they were
1576 not correctly detected by blhc (please report the bug in this case).
1582 The exit status is a "bit mask", each listed status is ORed when the error
1583 condition occurs to get the result.
1593 No compiler commands were found.
1597 Invalid arguments/options given to blhc.
1605 Missing hardening flags.
1609 Hardening wrapper detected, no tests performed.
1613 Invalid CMake version used. See B<I-invalid-cmake-used> under L</"BUILDD
1614 TAGS"> for a detailed explanation.
1620 Simon Ruderich, E<lt>simon@ruderich.orgE<gt>
1622 Thanks to to Bernhard R. Link E<lt>brlink@debian.orgE<gt> and Jaria Alto
1623 E<lt>jari.aalto@cante.netE<gt> for their valuable input and suggestions.
1625 =head1 LICENSE AND COPYRIGHT
1627 Copyright (C) 2012-2017 by Simon Ruderich
1629 This program is free software: you can redistribute it and/or modify
1630 it under the terms of the GNU General Public License as published by
1631 the Free Software Foundation, either version 3 of the License, or
1632 (at your option) any later version.
1634 This program is distributed in the hope that it will be useful,
1635 but WITHOUT ANY WARRANTY; without even the implied warranty of
1636 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1637 GNU General Public License for more details.
1639 You should have received a copy of the GNU General Public License
1640 along with this program. If not, see <http://www.gnu.org/licenses/>.
1644 L<hardening-check(1)>, L<dpkg-buildflags(1)>