3 # Build log hardening check, checks build logs for missing hardening flags.
5 # Copyright (C) 2012 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.03';
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\+\+)
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 = qr/
42 (?:[a-z0-9_]+-(?:linux-|kfreebsd-)?gnu(?:eabi|eabihf)?-)?
45 # Regex to catch (GCC) compiler warnings.
46 my $warning_regex = qr/^(.+?):(\d+):\d+: warning: (.+?) \[(.+?)\]$/;
48 # List of source file extensions which require preprocessing.
49 my @source_preprocess_compile_cpp = (
51 qw( cc cp cxx cpp CPP c++ C ),
55 my @source_preprocess_compile = (
61 @source_preprocess_compile_cpp,
63 qw( F FOR fpp FPP FTN F90 F95 F03 F08 ),
65 my @source_preprocess_no_compile = (
69 my @source_preprocess = (
70 @source_preprocess_compile,
71 @source_preprocess_no_compile,
73 # List of source file extensions which don't require preprocessing.
74 my @source_no_preprocess_compile_cpp = (
80 my @source_no_preprocess_compile = (
84 @source_no_preprocess_compile_cpp,
88 qw( f for ftn f90 f95 f03 f08 ),
90 my @source_no_preprocess_no_compile = (
94 my @source_no_preprocess = (
95 @source_no_preprocess_compile,
96 @source_no_preprocess_no_compile,
98 # List of header file extensions which require preprocessing.
99 my @header_preprocess = (
100 # C, C++, Objective-C, Objective-C++
103 qw( hh H hp hxx hpp HPP h++ tcc ),
107 # Normal object files.
109 # Libtool object files.
111 # Dynamic libraries. bzip2 uses .sho.
117 # Hashes for fast extensions lookup to check if a file falls in one of these
119 my %extensions_no_preprocess = map { $_ => 1 } (
120 @source_no_preprocess,
122 my %extensions_preprocess = map { $_ => 1 } (
126 my %extensions_compile_link = map { $_ => 1 } (
128 @source_no_preprocess,
130 my %extensions_compile = map { $_ => 1 } (
131 @source_preprocess_compile,
132 @source_no_preprocess_compile,
134 my %extensions_no_compile = map { $_ => 1 } (
135 @source_preprocess_no_compile,
136 @source_no_preprocess_no_compile,
138 my %extensions_compile_cpp = map { $_ => 1 } (
139 @source_preprocess_compile_cpp,
140 @source_no_preprocess_compile_cpp,
142 my %extensions_object = map { $_ => 1 } (
145 my %extension = map { $_ => 1 } (
146 @source_no_preprocess,
152 # Regexp to match file extensions.
153 my $file_extension_regex = qr/
155 \S+ # Filename without extension.
157 ([^\/\\.,;:\s]+)# File extension.
158 (?=\s|\\) # At end of word. Can't use \b because some files have non
159 # word characters at the end and because \b matches double
160 # extensions (like .cpp.o). Works always as all lines are
161 # terminated with "\n".
164 # Expected (hardening) flags. All flags are used as regexps.
169 my @def_cflags_format = (
171 '-Werror=format-security', # implies -Wformat-security
173 my @def_cflags_fortify = (
174 # fortify needs at least -O1, but -O2 is recommended anyway
176 my @def_cflags_stack = (
178 '--param=ssp-buffer-size=4',
180 my @def_cflags_pie = (
186 # @def_cxxflags_* is the same as @def_cflags_*.
187 my @def_cppflags = ();
188 my @def_cppflags_fortify = (
189 '-D_FORTIFY_SOURCE=2', # must be first, see cppflags_fortify_broken()
190 # If you add another flag fix hack below (search for "Hack to fix").
192 my @def_cppflags_fortify_bad = (
193 # These flags may overwrite -D_FORTIFY_SOURCE=2.
195 '-D_FORTIFY_SOURCE=0',
196 '-D_FORTIFY_SOURCE=1',
198 my @def_ldflags = ();
199 my @def_ldflags_relro = (
202 my @def_ldflags_bindnow = (
205 my @def_ldflags_pie = (
209 my @def_ldflags_pic = (
214 # References to all flags checked by the flag checker.
218 \@def_cflags_fortify,
223 \@def_cppflags_fortify,
226 \@def_ldflags_bindnow,
229 # References to all used flags.
230 my @flag_refs_all = (
232 \@def_cppflags_fortify_bad,
235 # Renaming rules for the output so the regex parts are not visible. Also
236 # stores string values of flag regexps above, see compile_flag_regexp().
238 '-O(?:2|3)' => '-O2',
239 '-Wl,(?:-z,)?relro' => '-Wl,-z,relro',
240 '-Wl,(?:-z,)?now' => '-Wl,-z,now',
244 no_compiler_commands => 1 << 0,
245 # used by POD::Usage => 1 << 1,
246 non_verbose_build => 1 << 2,
247 flags_missing => 1 << 3,
248 hardening_wrapper => 1 << 4,
249 invalid_cmake => 1 << 5,
253 no_compiler_commands => 'I-no-compiler-commands',
254 non_verbose_build => 'W-compiler-flags-hidden',
255 flags_missing => 'W-dpkg-buildflags-missing',
256 hardening_wrapper => 'I-hardening-wrapper-used',
257 invalid_cmake => 'I-invalid-cmake-used',
260 # Statistics of missing flags and non-verbose build commands. Used for
264 preprocess_missing => 0,
266 compile_missing => 0,
268 compile_cpp_missing => 0,
272 commands_nonverbose => 0,
275 # Use colored (ANSI) output?
282 my ($message, $missing_flags_ref, $flag_renames_ref, $line) = @_;
284 # Get string value of qr//-escaped regexps and if requested rename them.
285 my @missing_flags = map {
286 $flag_renames_ref->{$_}
287 } @{$missing_flags_ref};
289 my $flags = join ' ', @missing_flags;
290 printf '%s (%s)%s %s',
291 error_color($message, 'red'), $flags, error_color(':', 'yellow'),
294 sub error_non_verbose_build {
298 error_color('NONVERBOSE BUILD', 'red'),
299 error_color(':', 'yellow'),
302 sub error_invalid_cmake {
306 error_color('INVALID CMAKE', 'red'),
307 error_color(':', 'yellow'),
310 sub error_hardening_wrapper {
312 error_color('HARDENING WRAPPER', 'red'),
313 error_color(':', 'yellow'),
314 'no checks possible, aborting';
317 my ($message, $color) = @_;
320 return Term::ANSIColor::colored($message, $color);
327 my ($line, @flags) = @_;
329 foreach my $flag (@flags) {
330 return 1 if $line =~ /$flag/;
336 my ($line, $missing_flags_ref, @flags) = @_;
338 my @missing_flags = ();
339 foreach my $flag (@flags) {
340 if (not $line =~ /$flag/) {
341 push @missing_flags, $flag;
345 return 1 if scalar @missing_flags == 0;
347 @{$missing_flags_ref} = @missing_flags;
351 sub cppflags_fortify_broken {
352 my ($line, $missing_flags) = @_;
354 # This doesn't take the position into account, but is a simple solution.
355 # And if the build system tries to force -D_FORTIFY_SOURCE=0/1, something
358 if (any_flags_used($line, @def_cppflags_fortify_bad)) {
359 # $def_cppflags_fortify[0] must be -D_FORTIFY_SOURCE=2!
360 push @{$missing_flags}, $def_cppflags_fortify[0];
367 # Modifies $missing_flags_ref array.
368 sub pic_pie_conflict {
369 my ($line, $pie, $missing_flags_ref, @flags_pie) = @_;
371 return 0 if not $pie;
372 return 0 if not any_flags_used($line, @def_ldflags_pic);
374 my %flags = map { $_ => 1 } @flags_pie;
376 # Remove all PIE flags from @missing_flags as they are not required with
379 not exists $flags{$_}
380 } @{$missing_flags_ref};
381 @{$missing_flags_ref} = @result;
383 # We got a conflict when no flags are left, thus only PIE flags were
384 # missing. If other flags were missing abort because the conflict is not
386 return scalar @result == 0;
389 sub is_non_verbose_build {
390 my ($line, $next_line, $skip_ref) = @_;
392 if (not (index($line, 'checking if you want to see long compiling messages... no') == 0
393 or $line =~ /^\s*\[?(?:CC|CCLD|C\+\+|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/
394 or $line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
395 or $line =~ /^\s*[Bb]uilding (?:program|shared library)\s+(.+?)$/
396 or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
402 # C++ compiler setting.
403 return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
404 # "Compiling" with no file name.
405 if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) {
406 # $file_extension_regex may need spaces around the filename.
407 return 0 if not " $1 " =~ /$file_extension_regex/o;
412 # On the first pass we only check if this line is verbose or not.
413 return 1 if not defined $next_line;
415 # Second pass, we have access to the next line.
418 # CMake and other build systems print the non-verbose messages also when
419 # building verbose. If a compiler and the file name occurs in the next
420 # line, treat it as verbose build.
422 # Get filename, we can't use the complete path as only parts of it are
423 # used in the real compiler command.
424 $file =~ m{/([^/\s]+)$};
427 if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
428 # We still have to skip the current line as it doesn't contain any
439 my ($flag_refs_ref, $flag_renames_ref, @flags) = @_;
441 my %removes = map { $_ => 1 } @flags;
442 foreach my $flags (@{$flag_refs_ref}) {
444 # Flag found as string.
445 not exists $removes{$_}
446 # Flag found as string representation of regexp.
447 and (not defined $flag_renames_ref->{$_}
448 or not exists $removes{$flag_renames_ref->{$_}})
453 sub compile_flag_regexp {
454 my ($flag_renames_ref, @flags) = @_;
457 foreach my $flag (@flags) {
458 # Store flag name in replacement string for correct flags in messages
459 # with qr//ed flag regexps.
460 $flag_renames_ref->{qr/\s$flag(?:\s|\\)/}
461 = (exists $flag_renames_ref->{$flag})
462 ? $flag_renames_ref->{$flag}
465 # Compile flag regexp for faster execution.
466 push @result, qr/\s$flag(?:\s|\\)/;
471 sub extension_found {
472 my ($extensions_ref, @extensions) = @_;
475 foreach my $extension (@extensions) {
476 if (exists $extensions_ref->{$extension}) {
487 # Parse command line arguments.
489 my $option_version = 0;
491 my $option_bindnow = 0;
492 my @option_ignore_arch = ();
493 my @option_ignore_flag = ();
494 my @option_ignore_arch_flag = ();
495 my @option_ignore_line = ();
496 my @option_ignore_arch_line = ();
498 my $option_arch = undef;
499 my $option_buildd = 0;
501 if (not Getopt::Long::GetOptions(
502 'help|h|?' => \$option_help,
503 'version' => \$option_version,
505 'pie' => \$option_pie,
506 'bindnow' => \$option_bindnow,
507 'all' => \$option_all,
509 'ignore-arch=s' => \@option_ignore_arch,
510 'ignore-flag=s' => \@option_ignore_flag,
511 'ignore-arch-flag=s' => \@option_ignore_arch_flag,
512 'ignore-line=s' => \@option_ignore_line,
513 'ignore-arch-line=s' => \@option_ignore_arch_line,
515 'color' => \$option_color,
516 'arch=s' => \$option_arch,
517 'buildd' => \$option_buildd,
520 Pod::Usage::pod2usage(2);
524 Pod::Usage::pod2usage(1);
526 if ($option_version) {
527 print "blhc $VERSION Copyright (C) 2012 Simon Ruderich
529 This program is free software: you can redistribute it and/or modify
530 it under the terms of the GNU General Public License as published by
531 the Free Software Foundation, either version 3 of the License, or
532 (at your option) any later version.
534 This program is distributed in the hope that it will be useful,
535 but WITHOUT ANY WARRANTY; without even the implied warranty of
536 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
537 GNU General Public License for more details.
539 You should have received a copy of the GNU General Public License
540 along with this program. If not, see <http://www.gnu.org/licenses/>.
546 if (scalar @ARGV == 0) {
548 Pod::Usage::pod2usage(2);
551 # Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not
552 # installed on Debian's buildds.
553 if (not $option_buildd) {
554 require Term::ANSIColor;
562 # Precompiled ignores for faster lookup.
563 my %option_ignore_arch_flag = ();
564 my %option_ignore_arch_line = ();
566 # Strip flags which should be ignored.
567 if (scalar @option_ignore_flag > 0) {
568 remove_flags(\@flag_refs, \%flag_renames, @option_ignore_flag);
570 # Same for arch specific ignore flags, but only prepare here.
571 if (scalar @option_ignore_arch_flag > 0) {
572 foreach my $ignore (@option_ignore_arch_flag) {
573 my ($ignore_arch, $ignore_flag) = split ':', $ignore, 2;
575 if (not $ignore_arch or not $ignore_flag) {
576 printf STDERR 'Value "%s" invalid for option ignore-arch-flag '
577 . '("arch:flag" expected)' . "\n", $ignore;
579 Pod::Usage::pod2usage(2);
582 push @{$option_ignore_arch_flag{$ignore_arch}}, $ignore_flag;
586 # Precompile all flag regexps. any_flags_used(), all_flags_used() get a lot
588 foreach my $flags (@flag_refs_all) {
589 @{$flags} = compile_flag_regexp(\%flag_renames, @{$flags});
592 # Precompile ignore line regexps, also anchor at beginning and end of line.
593 foreach my $ignore (@option_ignore_line) {
594 $ignore = qr/^$ignore$/;
596 # Same for arch specific ignore lines.
597 if (scalar @option_ignore_arch_line > 0) {
598 foreach my $ignore (@option_ignore_arch_line) {
599 my ($ignore_arch, $ignore_line) = split ':', $ignore, 2;
601 if (not $ignore_arch or not $ignore_line) {
602 printf STDERR 'Value "%s" invalid for option ignore-arch-line '
603 . '("arch:line" expected)' . "\n", $ignore;
605 Pod::Usage::pod2usage(2);
608 push @{$option_ignore_arch_line{$ignore_arch}}, qr/^$ignore_line$/;
616 foreach my $file (@ARGV) {
617 print "checking '$file'...\n" if scalar @ARGV > 1;
619 -f $file or die "No such file: $file";
621 open my $fh, '<', $file or die $!;
623 # Architecture of this file.
624 my $arch = $option_arch;
626 # Hardening options. Not all architectures support all hardening options.
627 my $harden_format = 1;
628 my $harden_fortify = 1;
629 my $harden_stack = 1;
630 my $harden_relro = 1;
631 my $harden_bindnow = $option_bindnow; # defaults to 0
632 my $harden_pie = $option_pie; # defaults to 0
634 while (my $line = <$fh>) {
635 # Detect architecture automatically unless overridden. For buildd logs
636 # only, doesn't use the dpkg-buildpackage header. Necessary to ignore
637 # build logs which aren't built (wrong architecture, build error,
640 and $line =~ /^Architecture: (.+)$/) {
644 # dpkg-buildflags only provides hardening flags since 1.16.1, don't
645 # check for hardening flags in buildd mode if an older dpkg-dev is
646 # used. Default flags (-g -O2) are still checked.
648 # Packages which were built before 1.16.1 but used their own hardening
649 # flags are not checked.
651 and index($line, 'Toolchain package versions: ') == 0) {
652 require Dpkg::Version;
653 if (not $line =~ /\bdpkg-dev_(\S+)/
654 or Dpkg::Version::version_compare($1, '1.16.1') < 0) {
664 # The following two versions of CMake in Debian obeyed CPPFLAGS, but
665 # this was later dropped because upstream rejected the patch. Thus
666 # build logs with these versions will have fortify hardening flags
667 # enabled, even though they may be not correctly set and are missing
668 # when build with later CMake versions. Thanks to Aron Xu for letting
670 if (index($line, 'Package versions: ') == 0
671 and $line =~ /\bcmake_(\S+)/
672 and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
673 if (not $option_buildd) {
674 error_invalid_cmake($1);
675 $exit |= $exit_code{invalid_cmake};
677 print "$buildd_tag{invalid_cmake}|$1|\n";
681 # If hardening wrapper is used (wraps calls to gcc and adds hardening
682 # flags automatically) we can't perform any checks, abort.
683 if (index($line, 'Build-Depends: ') == 0
684 and $line =~ /\bhardening-wrapper\b/) {
685 if (not $option_buildd) {
686 error_hardening_wrapper();
687 $exit |= $exit_code{hardening_wrapper};
689 print "$buildd_tag{hardening_wrapper}||\n";
694 # We skip over unimportant lines at the beginning of the log to
695 # prevent false positives.
696 last if index($line, 'dpkg-buildpackage: ') == 0;
699 # Input lines, contain only the lines with compiler commands.
702 my $continuation = 0;
703 my $complete_line = undef;
704 while (my $line = <$fh>) {
705 # And stop at the end of the build log. Package details (reported by
706 # the buildd logs) are not important for us. This also prevents false
708 last if $line =~ /^Build finished at \d{8}-\d{4}$/;
710 # Detect architecture automatically unless overridden.
712 and $line =~ /^dpkg-buildpackage: host architecture (.+)$/) {
716 # Ignore compiler warnings for now.
717 next if $line =~ /$warning_regex/o;
719 if (not $option_buildd and index($line, "\033") != -1) { # esc
720 # Remove all ANSI color sequences which are sometimes used in
721 # non-verbose builds.
722 $line = Term::ANSIColor::colorstrip($line);
723 # Also strip '\0xf' (delete previous character), used by Elinks'
726 # And "ESC(B" which seems to be used on armhf and hurd (not sure
728 $line =~ s/\033\(B//g;
731 # Check if this line indicates a non verbose build.
732 my $non_verbose = is_non_verbose_build($line);
734 # One line may contain multiple commands (";"). Treat each one as
735 # single line. parse_line() is slow, only use it when necessary.
736 my @line = (index($line, ';') == -1)
739 # Ensure newline at the line end - necessary for
740 # correct parsing later.
743 } Text::ParseWords::parse_line(';', 1, $line);
744 foreach my $line (@line) {
748 # Join lines, but leave the "\" in place so it's clear where
749 # the original line break was.
750 chomp $complete_line;
751 $complete_line .= ' ' . $line;
753 # Line continuation, line ends with "\".
754 if ($line =~ /\\$/) {
756 # Start line continuation.
757 if (not defined $complete_line) {
758 $complete_line = $line;
763 # Use the complete line if a line continuation occurred.
764 if (defined $complete_line) {
765 $line = $complete_line;
766 $complete_line = undef;
769 # Ignore lines with no compiler commands.
770 next if not $non_verbose
771 and not $line =~ /\b$cc_regex(?:\s|\\)/o;
772 # Ignore lines with no filenames with extensions. May miss some
773 # non-verbose builds (e.g. "gcc -o test" [sic!]), but shouldn't be
774 # a problem as the log will most likely contain other non-verbose
775 # commands which are detected.
776 next if not $non_verbose
777 and not $line =~ /$file_extension_regex/o;
779 # Ignore false positives.
781 # `./configure` output.
782 next if not $non_verbose
783 and $line =~ /^(?:checking|[Cc]onfigure:) /;
784 next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
785 [Cc]ompiler[\s.]*:?\s+
787 next if $line =~ /^\s*(?:- )?(?:HOST_)?(?:CC|CXX)\s*=\s*$cc_regex_full\s*$/o;
788 # `moc-qt4`, contains '-I/usr/share/qt4/mkspecs/linux-g++' (or
789 # similar for other architectures) which gets recognized as a
790 # compiler line. Ignore it.
791 next if $line =~ m{^/usr/bin/moc-qt4
793 -I/usr/share/qt4/mkspecs/[a-z]+-g\++(?:-64)?
796 # Check if additional hardening options were used. Used to ensure
797 # they are used for the complete build.
798 $harden_pie = 1 if any_flags_used($line, @def_cflags_pie,
800 $harden_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
808 # Ignore arch if requested.
809 if (scalar @option_ignore_arch > 0 and $arch) {
810 foreach my $ignore (@option_ignore_arch) {
811 if ($arch eq $ignore) {
812 print "ignoring architecture '$arch'\n";
818 if (scalar @input == 0) {
819 if (not $option_buildd) {
820 print "No compiler commands!\n";
821 $exit |= $exit_code{no_compiler_commands};
823 print "$buildd_tag{no_compiler_commands}||\n";
828 if ($option_buildd) {
829 $statistics{commands} += scalar @input;
832 # Option or auto detected.
834 # The following was partially copied from dpkg-dev 1.16.1.2
835 # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, add_hardening_flags()),
836 # copyright Raphaël Hertzog <hertzog@debian.org>, Kees Cook
837 # <kees@debian.org>, Canonical, Ltd. licensed under GPL version 2 or
838 # later. Keep it in sync.
841 my ($abi, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
843 # Disable unsupported hardening options.
844 if ($cpu =~ /^(?:ia64|alpha|mips|mipsel|hppa)$/ or $arch eq 'arm') {
847 if ($cpu =~ /^(?:ia64|hppa|avr32)$/) {
854 my @cflags = @def_cflags;
855 my @cxxflags = @def_cxxflags;
856 my @cppflags = @def_cppflags;
857 my @ldflags = @def_ldflags;
858 # Check the specified hardening options, same order as dpkg-buildflags.
860 @cflags = (@cflags, @def_cflags_pie);
861 @cxxflags = (@cxxflags, @def_cflags_pie);
862 @ldflags = (@ldflags, @def_ldflags_pie);
865 @cflags = (@cflags, @def_cflags_stack);
866 @cxxflags = (@cxxflags, @def_cflags_stack);
868 if ($harden_fortify) {
869 @cflags = (@cflags, @def_cflags_fortify);
870 @cxxflags = (@cxxflags, @def_cflags_fortify);
871 @cppflags = (@cppflags, @def_cppflags_fortify);
873 if ($harden_format) {
874 @cflags = (@cflags, @def_cflags_format);
875 @cxxflags = (@cxxflags, @def_cflags_format);
878 @ldflags = (@ldflags, @def_ldflags_relro);
880 if ($harden_bindnow) {
881 @ldflags = (@ldflags, @def_ldflags_bindnow);
884 # Hack to fix cppflags_fortify_broken() if --ignore-flag
885 # -D_FORTIFY_SOURCE=2 is used to ignore missing fortification. Only works
886 # as long as @def_cppflags_fortify contains only one variable.
887 if (scalar @def_cppflags_fortify == 0) {
891 # Ignore flags for this arch if requested.
892 if ($arch and exists $option_ignore_arch_flag{$arch}) {
893 my @flag_refs = (\@cflags, \@cxxflags, \@cppflags, \@ldflags);
895 remove_flags(\@flag_refs,
897 @{$option_ignore_arch_flag{$arch}});
900 my @ignore_line = @option_ignore_line;
901 # Ignore lines for this arch if requested.
902 if ($arch and exists $option_ignore_arch_line{$arch}) {
903 @ignore_line = (@ignore_line, @{$option_ignore_arch_line{$arch}});
907 for (my $i = 0; $i < scalar @input; $i++) {
908 my $line = $input[$i];
910 # Ignore line if requested.
911 foreach my $ignore (@ignore_line) {
912 next LINE if $line =~ /$ignore/;
916 if (is_non_verbose_build($line, $input[$i + 1], \$skip)) {
917 if (not $option_buildd) {
918 error_non_verbose_build($line);
919 $exit |= $exit_code{non_verbose_build};
921 $statistics{commands_nonverbose}++;
925 # Even if it's a verbose build, we might have to skip this line.
928 # Remove everything until and including the compiler command. Makes
929 # checks easier and faster.
930 $line =~ s/^.*?$cc_regex//o;
931 # "([...] test.c)" is not detected as 'test.c' - fix this by removing
932 # the brace and similar characters.
933 $line =~ s/['")]+$//;
935 # Skip unnecessary tests when only preprocessing.
936 my $flag_preprocess = 0;
943 # Preprocess, compile, assemble.
944 if ($line =~ /\s(-E|-S|-c)\b/) {
946 $flag_preprocess = 1 if $1 eq '-E';
947 $compile = 1 if $1 eq '-S' or $1 eq '-c';
948 # Dependency generation for Makefiles. The other flags (-MF -MG -MP
949 # -MT -MQ) are always used with -M/-MM.
950 } elsif ($line =~ /\s(?:-M|-MM)\b/) {
952 # Otherwise assume we are linking.
957 # -MD/-MMD also cause dependency generation, but they don't imply -E!
958 if ($line =~ /\s(?:-MD|-MMD)\b/) {
960 $flag_preprocess = 0;
963 # Dependency generation for Makefiles, no preprocessing or other flags
967 # Get all file extensions on this line.
968 my @extensions = $line =~ /$file_extension_regex/go;
969 # Ignore all unknown extensions to speedup the search below.
970 @extensions = grep { exists $extension{$_} } @extensions;
972 # These file types don't require preprocessing.
973 if (extension_found(\%extensions_no_preprocess, @extensions)) {
976 # These file types require preprocessing.
977 if (extension_found(\%extensions_preprocess, @extensions)) {
981 if (not $flag_preprocess) {
982 # If there are source files then it's compiling/linking in one
983 # step and we must check both. We only check for source files
984 # here, because header files cause too many false positives.
985 if (extension_found(\%extensions_compile_link, @extensions)) {
986 # Assembly files don't need CFLAGS.
987 if (not extension_found(\%extensions_compile, @extensions)
988 and extension_found(\%extensions_no_compile, @extensions)) {
994 # No compilable extensions found, either linking or compiling
997 # If there are also no object files we are just compiling headers
998 # (.h -> .h.gch). Don't check for linker flags in this case. Due
999 # to our liberal checks for compiler lines, this also reduces the
1000 # number of false positives considerably.
1002 and not extension_found(\%extensions_object, @extensions)) {
1007 # Assume CXXFLAGS are required when a C++ file is specified in the
1009 my $compile_cpp = 0;
1011 and extension_found(\%extensions_compile_cpp, @extensions)) {
1016 if ($option_buildd) {
1017 $statistics{preprocess}++ if $preprocess;
1018 $statistics{compile}++ if $compile;
1019 $statistics{compile_cpp}++ if $compile_cpp;
1020 $statistics{link}++ if $link;
1023 # Check hardening flags.
1025 if ($compile and not all_flags_used($line, \@missing, @cflags)
1026 # Libraries linked with -fPIC don't have to (and can't) be
1027 # linked with -fPIE as well. It's no error if only PIE flags
1029 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1030 # Assume dpkg-buildflags returns the correct flags.
1031 and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
1032 if (not $option_buildd) {
1033 error_flags('CFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1034 $exit |= $exit_code{flags_missing};
1036 $statistics{compile_missing}++;
1038 } elsif ($compile_cpp and not all_flags_used($line, \@missing, @cflags)
1039 # Libraries linked with -fPIC don't have to (and can't) be
1040 # linked with -fPIE as well. It's no error if only PIE flags
1042 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1043 # Assume dpkg-buildflags returns the correct flags.
1044 and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
1045 if (not $option_buildd) {
1046 error_flags('CXXFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1047 $exit |= $exit_code{flags_missing};
1049 $statistics{compile_cpp_missing}++;
1053 and (not all_flags_used($line, \@missing, @cppflags)
1054 # The fortify flag might be overwritten, detect that.
1056 and cppflags_fortify_broken($line, \@missing)))
1057 # Assume dpkg-buildflags returns the correct flags.
1058 and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
1059 if (not $option_buildd) {
1060 error_flags('CPPFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1061 $exit |= $exit_code{flags_missing};
1063 $statistics{preprocess_missing}++;
1066 if ($link and not all_flags_used($line, \@missing, @ldflags)
1067 # Same here, -fPIC conflicts with -fPIE.
1068 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie)
1069 # Assume dpkg-buildflags returns the correct flags.
1070 and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
1071 if (not $option_buildd) {
1072 error_flags('LDFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1073 $exit |= $exit_code{flags_missing};
1075 $statistics{link_missing}++;
1081 # Print statistics for buildd mode, only output in this mode.
1082 if ($option_buildd) {
1085 if ($statistics{preprocess_missing}) {
1086 push @warning, sprintf 'CPPFLAGS %d (of %d)',
1087 $statistics{preprocess_missing},
1088 $statistics{preprocess};
1090 if ($statistics{compile_missing}) {
1091 push @warning, sprintf 'CFLAGS %d (of %d)',
1092 $statistics{compile_missing},
1093 $statistics{compile};
1095 if ($statistics{compile_cpp_missing}) {
1096 push @warning, sprintf 'CXXFLAGS %d (of %d)',
1097 $statistics{compile_cpp_missing},
1098 $statistics{compile_cpp};
1100 if ($statistics{link_missing}) {
1101 push @warning, sprintf 'LDFLAGS %d (of %d)',
1102 $statistics{link_missing},
1105 if (scalar @warning) {
1106 local $" = ', '; # array join string
1107 print "$buildd_tag{flags_missing}|@warning missing|\n";
1110 if ($statistics{commands_nonverbose}) {
1111 printf "$buildd_tag{non_verbose_build}|%d (of %d) hidden|\n",
1112 $statistics{commands_nonverbose},
1113 $statistics{commands},
1125 blhc - build log hardening check, checks build logs for missing hardening flags
1129 B<blhc> [I<options>] I<< <dpkg-buildpackage build log file>.. >>
1133 blhc is a small tool which checks build logs for missing hardening flags. It's
1134 licensed under the GPL 3 or later.
1136 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
1137 tools using dpkg-buildpackage like pbuilder or the official buildd build logs)
1138 to help maintainers detect missing hardening flags in their packages.
1140 Only gcc is detected as compiler at the moment. If other compilers support
1141 hardening flags as well, please report them.
1143 If there's no output, no flags are missing and the build log is fine.
1151 Force check for all +all (+pie, +bindnow) hardening flags. By default it's
1154 =item B<--arch> I<architecture>
1156 Set the specific architecture (e.g. amd64, armel, etc.), automatically
1157 disables hardening flags not available on this architecture. Is detected
1158 automatically if dpkg-buildpackage is used.
1162 Force check for all +bindnow hardening flags. By default it's auto detected.
1166 Special mode for buildds when automatically parsing log files. The following
1167 changes are in effect:
1173 Print tags instead of normal warnings, see L</"BUILDD TAGS"> for a list of
1178 Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is
1183 Don't require Term::ANSIColor.
1187 Return exit code 0, unless there was a error (-I, -W messages don't count as
1194 Use colored (ANSI) output for warning messages.
1196 =item B<--ignore-arch> I<arch>
1198 Ignore build logs from architectures matching I<arch>. I<arch> is a string.
1200 Used to prevent false positives. This option can be specified multiple times.
1202 =item B<--ignore-arch-flag> I<arch>:I<flag>
1204 Like B<--ignore-flag>, but only ignore flag on I<arch>.
1206 =item B<--ignore-arch-line> I<arch>:I<line>
1208 Like B<--ignore-line>, but only ignore line on I<arch>.
1210 =item B<--ignore-flag> I<flag>
1212 Don't print an error when the specific flag is missing in a compiler line.
1213 I<flag> is a string.
1215 Used to prevent false positives. This option can be specified multiple times.
1217 =item B<--ignore-line> I<regex>
1219 Ignore lines matching the given Perl regex. I<regex> is automatically anchored
1220 at the beginning and end of the line to prevent false negatives.
1222 B<NOTE>: Not the input lines are checked, but the lines which are displayed in
1223 warnings (which have line continuation resolved).
1225 Used to prevent false positives. This option can be specified multiple times.
1229 Force check for all +pie hardening flags. By default it's auto detected.
1231 =item B<-h -? --help>
1233 Print available options.
1237 Print version number and license.
1241 Auto detection for B<--pie> and B<--bindnow> only works if at least one
1242 command uses the required hardening flag (e.g. -fPIE). Then it's required for
1243 all other commands as well.
1247 Normal usage, parse a single log file.
1249 blhc path/to/log/file
1251 If there's no output, no flags are missing and the build log is fine.
1253 Parse multiple log files. The exit code is ORed over all files.
1255 blhc path/to/directory/with/log/files/*
1257 Don't treat missing C<-g> as error:
1259 blhc --ignore-flag -g path/to/log/file
1261 Don't treat missing C<-pie> on kfreebsd-amd64 as error:
1263 blhc --ignore-arch-flag kfreebsd-amd64:-pie path/to/log/file
1265 Ignore lines consisting exactly of C<./script gcc file> which would cause a
1268 blhc --ignore-line '\./script gcc file' path/to/log/file
1270 Ignore lines matching C<./script gcc file> somewhere in the line.
1272 blhc --ignore-line '.*\./script gcc file.*' path/to/log/file
1274 Use blhc with pbuilder.
1276 pbuilder path/to/package.dsc | tee path/log/file
1277 blhc path/to/file || echo flags missing
1281 The following tags are used in I<--buildd> mode. In braces the additional data
1286 =item B<I-hardening-wrapper-used>
1288 The package uses hardening-wrapper which intercepts calls to gcc and adds
1289 hardening flags. The build log doesn't contain any hardening flags and thus
1290 can't be checked by blhc.
1292 =item B<W-compiler-flags-hidden> (summary of hidden lines)
1294 Build log contains lines which hide the real compiler flags. For example:
1301 Most of the time either C<export V=1> or C<export verbose=1> in
1302 F<debian/rules> fixes builds with hidden compiler flags. Sometimes C<.SILENT>
1303 in a F<Makefile> must be removed. And as last resort the F<Makefile> must be
1304 patched to remove the C<@>s hiding the real compiler commands.
1306 =item B<W-dpkg-buildflags-missing> (summary of missing flags)
1308 CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
1310 =item B<I-invalid-cmake-used> (version)
1312 By default CMake ignores CPPFLAGS thus missing those hardening flags. Debian
1313 patched CMake in versions 2.8.7-1 and 2.8.7-2 to respect CPPFLAGS, but this
1314 patch was rejected by upstream and later reverted in Debian. Thus those two
1315 versions show correct usage of CPPFLAGS even if the package doesn't correctly
1316 handle them (for example by passing them to CFLAGS). To prevent false
1317 negatives just blacklist those two versions.
1319 =item B<I-no-compiler-commands>
1321 No compiler commands were detected. Either the log contains none or they were
1322 not correctly detected by blhc (please report the bug in this case).
1328 The exit status is a "bit mask", each listed status is ORed when the error
1329 condition occurs to get the result.
1339 No compiler commands were found.
1343 Invalid arguments/options given to blhc.
1351 Missing hardening flags.
1355 Hardening wrapper detected, no tests performed.
1359 Invalid CMake version used. See B<I-invalid-cmake-used> under L</"BUILDD
1360 TAGS"> for a detailed explanation.
1366 Simon Ruderich, E<lt>simon@ruderich.orgE<gt>
1368 Thanks to to Bernhard R. Link E<lt>brlink@debian.orgE<gt> and Jaria Alto
1369 E<lt>jari.aalto@cante.netE<gt> for their valuable input and suggestions.
1371 =head1 COPYRIGHT AND LICENSE
1373 Copyright (C) 2012 by Simon Ruderich
1375 This program is free software: you can redistribute it and/or modify
1376 it under the terms of the GNU General Public License as published by
1377 the Free Software Foundation, either version 3 of the License, or
1378 (at your option) any later version.
1380 This program is distributed in the hope that it will be useful,
1381 but WITHOUT ANY WARRANTY; without even the implied warranty of
1382 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1383 GNU General Public License for more details.
1385 You should have received a copy of the GNU General Public License
1386 along with this program. If not, see <http://www.gnu.org/licenses/>.
1390 L<hardening-check(1)>, L<dpkg-buildflags(1)>