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 check if a line contains a compiler command.
46 my $cc_regex_normal = qr/
49 # Regex to catch (GCC) compiler warnings.
50 my $warning_regex = qr/^(.+?):(\d+):\d+: warning: (.+?) \[(.+?)\]$/;
52 # List of source file extensions which require preprocessing.
53 my @source_preprocess_compile_cpp = (
55 qw( cc cp cxx cpp CPP c++ C ),
59 my @source_preprocess_compile = (
65 @source_preprocess_compile_cpp,
67 qw( F FOR fpp FPP FTN F90 F95 F03 F08 ),
69 my @source_preprocess_no_compile = (
73 my @source_preprocess = (
74 @source_preprocess_compile,
75 @source_preprocess_no_compile,
77 # List of source file extensions which don't require preprocessing.
78 my @source_no_preprocess_compile_cpp = (
84 my @source_no_preprocess_compile_ada = (
87 # If you add another file, fix use of @source_no_preprocess_compile_ada
88 # below (search for $compile_ada).
90 my @source_no_preprocess_compile = (
94 @source_no_preprocess_compile_cpp,
98 qw( f for ftn f90 f95 f03 f08 ),
100 @source_no_preprocess_compile_ada,
102 my @source_no_preprocess_no_compile = (
108 my @source_no_preprocess = (
109 @source_no_preprocess_compile,
110 @source_no_preprocess_no_compile,
112 # List of header file extensions which require preprocessing.
113 my @header_preprocess = (
114 # C, C++, Objective-C, Objective-C++
117 qw( hh H hp hxx hpp HPP h++ tcc ),
121 # Normal object files.
123 # Libtool object files.
125 # Dynamic libraries. bzip2 uses .sho.
131 # Hashes for fast extensions lookup to check if a file falls in one of these
133 my %extensions_no_preprocess = map { $_ => 1 } (
134 # There's no @header_no_preprocess.
135 @source_no_preprocess,
137 my %extensions_preprocess = map { $_ => 1 } (
141 my %extensions_compile_link = map { $_ => 1 } (
143 @source_no_preprocess,
145 my %extensions_compile = map { $_ => 1 } (
146 @source_preprocess_compile,
147 @source_no_preprocess_compile,
149 my %extensions_no_compile = map { $_ => 1 } (
150 @source_preprocess_no_compile,
151 @source_no_preprocess_no_compile,
153 my %extensions_compile_cpp = map { $_ => 1 } (
154 @source_preprocess_compile_cpp,
155 @source_no_preprocess_compile_cpp,
157 my %extensions_object = map { $_ => 1 } (
160 my %extension = map { $_ => 1 } (
161 @source_no_preprocess,
167 # Regexp to match file extensions.
168 my $file_extension_regex = qr/
170 \S+ # Filename without extension.
172 ([^\/\\.,;:\s]+)# File extension.
173 (?=\s|\\) # At end of word. Can't use \b because some files have non
174 # word characters at the end and because \b matches double
175 # extensions (like .cpp.o). Works always as all lines are
176 # terminated with "\n".
179 # Expected (hardening) flags. All flags are used as regexps.
184 my @def_cflags_format = (
185 '-Wformat(?:=2)?', # -Wformat=2 implies -Wformat, accept it too
186 '-Werror=format-security', # implies -Wformat-security
188 my @def_cflags_fortify = (
189 # fortify needs at least -O1, but -O2 is recommended anyway
191 my @def_cflags_stack = (
193 '--param=ssp-buffer-size=4',
195 my @def_cflags_pie = (
201 # @def_cxxflags_* is the same as @def_cflags_*.
202 my @def_cppflags = ();
203 my @def_cppflags_fortify = (
204 '-D_FORTIFY_SOURCE=2', # must be first, see cppflags_fortify_broken()
205 # If you add another flag fix hack below (search for "Hack to fix").
207 my @def_cppflags_fortify_bad = (
208 # These flags may overwrite -D_FORTIFY_SOURCE=2.
210 '-D_FORTIFY_SOURCE=0',
211 '-D_FORTIFY_SOURCE=1',
213 my @def_ldflags = ();
214 my @def_ldflags_relro = (
217 my @def_ldflags_bindnow = (
220 my @def_ldflags_pie = (
224 my @def_ldflags_pic = (
229 # References to all flags checked by the flag checker.
233 \@def_cflags_fortify,
238 \@def_cppflags_fortify,
241 \@def_ldflags_bindnow,
244 # References to all used flags.
245 my @flag_refs_all = (
247 \@def_cppflags_fortify_bad,
250 # Renaming rules for the output so the regex parts are not visible. Also
251 # stores string values of flag regexps above, see compile_flag_regexp().
253 '-O(?:2|3)' => '-O2',
254 '-Wformat(?:=2)?' => '-Wformat',
255 '-Wl,(?:-z,)?relro' => '-Wl,-z,relro',
256 '-Wl,(?:-z,)?now' => '-Wl,-z,now',
260 no_compiler_commands => 1 << 0,
261 # used by POD::Usage => 1 << 1,
262 non_verbose_build => 1 << 2,
263 flags_missing => 1 << 3,
264 hardening_wrapper => 1 << 4,
265 invalid_cmake => 1 << 5,
269 no_compiler_commands => 'I-no-compiler-commands',
270 non_verbose_build => 'W-compiler-flags-hidden',
271 flags_missing => 'W-dpkg-buildflags-missing',
272 hardening_wrapper => 'I-hardening-wrapper-used',
273 invalid_cmake => 'I-invalid-cmake-used',
276 # Statistics of missing flags and non-verbose build commands. Used for
280 preprocess_missing => 0,
282 compile_missing => 0,
284 compile_cpp_missing => 0,
288 commands_nonverbose => 0,
291 # Use colored (ANSI) output?
297 # Only works for single-level arrays with no undef values. Thanks to perlfaq4.
299 my ($first_ref, $second_ref) = @_;
301 return 0 if scalar @{$first_ref} != scalar @{$second_ref};
303 my $length = scalar @{$first_ref};
304 for (my $i = 0; $i < $length; $i++) {
305 return 0 if $first_ref->[$i] ne $second_ref->[$i];
312 my ($message, $missing_flags_ref, $flag_renames_ref, $line) = @_;
314 # Get string value of qr//-escaped regexps and if requested rename them.
315 my @missing_flags = map {
316 $flag_renames_ref->{$_}
317 } @{$missing_flags_ref};
319 my $flags = join ' ', @missing_flags;
320 printf '%s (%s)%s %s',
321 error_color($message, 'red'), $flags, error_color(':', 'yellow'),
326 sub error_non_verbose_build {
330 error_color('NONVERBOSE BUILD', 'red'),
331 error_color(':', 'yellow'),
336 sub error_invalid_cmake {
340 error_color('INVALID CMAKE', 'red'),
341 error_color(':', 'yellow'),
346 sub error_hardening_wrapper {
348 error_color('HARDENING WRAPPER', 'red'),
349 error_color(':', 'yellow'),
350 'no checks possible, aborting';
355 my ($message, $color) = @_;
358 return Term::ANSIColor::colored($message, $color);
365 my ($line, @flags) = @_;
367 foreach my $flag (@flags) {
368 return 1 if $line =~ /$flag/;
374 my ($line, $missing_flags_ref, @flags) = @_;
376 my @missing_flags = ();
377 foreach my $flag (@flags) {
378 if (not $line =~ /$flag/) {
379 push @missing_flags, $flag;
383 return 1 if scalar @missing_flags == 0;
385 @{$missing_flags_ref} = @missing_flags;
389 sub cppflags_fortify_broken {
390 my ($line, $missing_flags) = @_;
392 # This doesn't take the position into account, but is a simple solution.
393 # And if the build system tries to force -D_FORTIFY_SOURCE=0/1, something
396 if (any_flags_used($line, @def_cppflags_fortify_bad)) {
397 # $def_cppflags_fortify[0] must be -D_FORTIFY_SOURCE=2!
398 push @{$missing_flags}, $def_cppflags_fortify[0];
405 # Modifies $missing_flags_ref array.
406 sub pic_pie_conflict {
407 my ($line, $pie, $missing_flags_ref, @flags_pie) = @_;
409 return 0 if not $pie;
410 return 0 if not any_flags_used($line, @def_ldflags_pic);
412 my %flags = map { $_ => 1 } @flags_pie;
414 # Remove all PIE flags from @missing_flags as they are not required with
417 not exists $flags{$_}
418 } @{$missing_flags_ref};
419 @{$missing_flags_ref} = @result;
421 # We got a conflict when no flags are left, thus only PIE flags were
422 # missing. If other flags were missing abort because the conflict is not
424 return scalar @result == 0;
427 sub is_non_verbose_build {
428 my ($line, $next_line, $skip_ref) = @_;
430 if (not (index($line, 'checking if you want to see long compiling messages... no') == 0
431 or $line =~ /^\s*\[?(?:CC|CCLD|C\+\+|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/
432 or $line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
433 or $line =~ /^\s*[Bb]uilding (?:program|shared library)\s+(.+?)$/
434 or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
440 # C++ compiler setting.
441 return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
442 # "Compiling" with no file name.
443 if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) {
444 # $file_extension_regex may need spaces around the filename.
445 return 0 if not " $1 " =~ /$file_extension_regex/o;
450 # On the first pass we only check if this line is verbose or not.
451 return 1 if not defined $next_line;
453 # Second pass, we have access to the next line.
456 # CMake and other build systems print the non-verbose messages also when
457 # building verbose. If a compiler and the file name occurs in the next
458 # line, treat it as verbose build.
460 # Get filename, we can't use the complete path as only parts of it are
461 # used in the real compiler command.
462 $file =~ m{/([^/\s]+)$};
465 if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
466 # Not a non-verbose line, but we still have to skip the current line
467 # as it doesn't contain any compiler commands.
477 my ($flag_refs_ref, $flag_renames_ref, @flags) = @_;
479 my %removes = map { $_ => 1 } @flags;
480 foreach my $flags (@{$flag_refs_ref}) {
482 # Flag found as string.
483 not exists $removes{$_}
484 # Flag found as string representation of regexp.
485 and (not defined $flag_renames_ref->{$_}
486 or not exists $removes{$flag_renames_ref->{$_}})
493 sub compile_flag_regexp {
494 my ($flag_renames_ref, @flags) = @_;
497 foreach my $flag (@flags) {
498 # Store flag name in replacement string for correct flags in messages
499 # with qr//ed flag regexps.
500 $flag_renames_ref->{qr/\s$flag(?:\s|\\)/}
501 = (exists $flag_renames_ref->{$flag})
502 ? $flag_renames_ref->{$flag}
505 # Compile flag regexp for faster execution.
506 push @result, qr/\s$flag(?:\s|\\)/;
511 sub extension_found {
512 my ($extensions_ref, @extensions) = @_;
515 foreach my $extension (@extensions) {
516 if (exists $extensions_ref->{$extension}) {
527 # Parse command line arguments.
529 my $option_version = 0;
531 my $option_bindnow = 0;
532 my @option_ignore_arch = ();
533 my @option_ignore_flag = ();
534 my @option_ignore_arch_flag = ();
535 my @option_ignore_line = ();
536 my @option_ignore_arch_line = ();
538 my $option_arch = undef;
539 my $option_buildd = 0;
541 if (not Getopt::Long::GetOptions(
542 'help|h|?' => \$option_help,
543 'version' => \$option_version,
545 'pie' => \$option_pie,
546 'bindnow' => \$option_bindnow,
547 'all' => \$option_all,
549 'ignore-arch=s' => \@option_ignore_arch,
550 'ignore-flag=s' => \@option_ignore_flag,
551 'ignore-arch-flag=s' => \@option_ignore_arch_flag,
552 'ignore-line=s' => \@option_ignore_line,
553 'ignore-arch-line=s' => \@option_ignore_arch_line,
555 'color' => \$option_color,
556 'arch=s' => \$option_arch,
557 'buildd' => \$option_buildd,
560 Pod::Usage::pod2usage(2);
564 Pod::Usage::pod2usage(1);
566 if ($option_version) {
567 print "blhc $VERSION Copyright (C) 2012 Simon Ruderich
569 This program is free software: you can redistribute it and/or modify
570 it under the terms of the GNU General Public License as published by
571 the Free Software Foundation, either version 3 of the License, or
572 (at your option) any later version.
574 This program is distributed in the hope that it will be useful,
575 but WITHOUT ANY WARRANTY; without even the implied warranty of
576 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
577 GNU General Public License for more details.
579 You should have received a copy of the GNU General Public License
580 along with this program. If not, see <http://www.gnu.org/licenses/>.
586 if (scalar @ARGV == 0) {
588 Pod::Usage::pod2usage(2);
591 # Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not
592 # installed on Debian's buildds.
593 if (not $option_buildd) {
594 require Term::ANSIColor;
602 # Precompiled ignores for faster lookup.
603 my %option_ignore_arch_flag = ();
604 my %option_ignore_arch_line = ();
606 # Strip flags which should be ignored.
607 if (scalar @option_ignore_flag > 0) {
608 remove_flags(\@flag_refs, \%flag_renames, @option_ignore_flag);
610 # Same for arch specific ignore flags, but only prepare here.
611 if (scalar @option_ignore_arch_flag > 0) {
612 foreach my $ignore (@option_ignore_arch_flag) {
613 my ($ignore_arch, $ignore_flag) = split /:/, $ignore, 2;
615 if (not $ignore_arch or not $ignore_flag) {
616 printf STDERR 'Value "%s" invalid for option ignore-arch-flag '
617 . '("arch:flag" expected)' . "\n", $ignore;
619 Pod::Usage::pod2usage(2);
622 push @{$option_ignore_arch_flag{$ignore_arch}}, $ignore_flag;
626 # Precompile all flag regexps. any_flags_used(), all_flags_used() get a lot
628 foreach my $flags (@flag_refs_all) {
629 @{$flags} = compile_flag_regexp(\%flag_renames, @{$flags});
632 # Precompile ignore line regexps, also anchor at beginning and end of line.
633 foreach my $ignore (@option_ignore_line) {
634 $ignore = qr/^$ignore$/;
636 # Same for arch specific ignore lines.
637 if (scalar @option_ignore_arch_line > 0) {
638 foreach my $ignore (@option_ignore_arch_line) {
639 my ($ignore_arch, $ignore_line) = split /:/, $ignore, 2;
641 if (not $ignore_arch or not $ignore_line) {
642 printf STDERR 'Value "%s" invalid for option ignore-arch-line '
643 . '("arch:line" expected)' . "\n", $ignore;
645 Pod::Usage::pod2usage(2);
648 push @{$option_ignore_arch_line{$ignore_arch}}, qr/^$ignore_line$/;
656 foreach my $file (@ARGV) {
657 print "checking '$file'...\n" if scalar @ARGV > 1;
659 -f $file or die "No such file: $file";
661 open my $fh, '<', $file or die $!;
663 # Architecture of this file.
664 my $arch = $option_arch;
666 # Hardening options. Not all architectures support all hardening options.
667 my $harden_format = 1;
668 my $harden_fortify = 1;
669 my $harden_stack = 1;
670 my $harden_relro = 1;
671 my $harden_bindnow = $option_bindnow; # defaults to 0
672 my $harden_pie = $option_pie; # defaults to 0
674 # Does this build log use ada? Ada also uses gcc as compiler but uses
675 # different CFLAGS. But only perform ada checks if an ada compiler used
676 # for performance reasons.
679 while (my $line = <$fh>) {
680 # Detect architecture automatically unless overridden. For buildd logs
681 # only, doesn't use the dpkg-buildpackage header. Necessary to ignore
682 # build logs which aren't built (wrong architecture, build error,
684 if (not $arch and index($line, 'Architecture: ') == 0) {
685 $arch = substr $line, 14, -1; # -1 to ignore '\n' at the end
688 # dpkg-buildflags only provides hardening flags since 1.16.1, don't
689 # check for hardening flags in buildd mode if an older dpkg-dev is
690 # used. Default flags (-g -O2) are still checked.
692 # Packages which were built before 1.16.1 but used their own hardening
693 # flags are not checked.
695 and index($line, 'Toolchain package versions: ') == 0) {
696 require Dpkg::Version;
697 if (not $line =~ /\bdpkg-dev_(\S+)/
698 or Dpkg::Version::version_compare($1, '1.16.1') < 0) {
708 # The following two versions of CMake in Debian obeyed CPPFLAGS, but
709 # this was later dropped because upstream rejected the patch. Thus
710 # build logs with these versions will have fortify hardening flags
711 # enabled, even though they may be not correctly set and are missing
712 # when build with later CMake versions. Thanks to Aron Xu for letting
714 if (index($line, 'Package versions: ') == 0
715 and $line =~ /\bcmake_(\S+)/
716 and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
717 if (not $option_buildd) {
718 error_invalid_cmake($1);
719 $exit |= $exit_code{invalid_cmake};
721 print "$buildd_tag{invalid_cmake}|$1|\n";
725 if (index($line, 'Build-Depends: ') == 0) {
726 # If hardening wrapper is used (wraps calls to gcc and adds
727 # hardening flags automatically) we can't perform any checks,
729 if ($line =~ /\bhardening-wrapper\b/) {
730 if (not $option_buildd) {
731 error_hardening_wrapper();
732 $exit |= $exit_code{hardening_wrapper};
734 print "$buildd_tag{hardening_wrapper}||\n";
740 if ($line =~ /\bgnat\b/) {
745 # We skip over unimportant lines at the beginning of the log to
746 # prevent false positives.
747 last if index($line, 'dpkg-buildpackage: ') == 0;
750 # Input lines, contain only the lines with compiler commands.
752 # Non-verbose lines in the input. Used to reduce calls to
753 # is_non_verbose_build() (which is quite slow) in the second loop when
754 # it's already clear if a line is non-verbose or not.
755 my @input_nonverbose = ();
757 my $continuation = 0;
758 my $complete_line = undef;
759 while (my $line = <$fh>) {
760 # And stop at the end of the build log. Package details (reported by
761 # the buildd logs) are not important for us. This also prevents false
763 last if index($line, 'Build finished at ') == 0
764 and $line =~ /^Build finished at \d{8}-\d{4}$/;
766 # Detect architecture automatically unless overridden.
768 and index($line, 'dpkg-buildpackage: host architecture ') == 0) {
769 $arch = substr $line, 37, -1; # -1 to ignore '\n' at the end
772 # Ignore compiler warnings for now.
773 next if $line =~ /$warning_regex/o;
775 if (not $option_buildd and index($line, "\033") != -1) { # \033 = esc
776 # Remove all ANSI color sequences which are sometimes used in
777 # non-verbose builds.
778 $line = Term::ANSIColor::colorstrip($line);
779 # Also strip '\0xf' (delete previous character), used by Elinks'
782 # And "ESC(B" which seems to be used on armhf and hurd (not sure
784 $line =~ s/\033\(B//g;
787 # Check if this line indicates a non verbose build.
788 my $non_verbose = is_non_verbose_build($line);
790 # One line may contain multiple commands (";"). Treat each one as
791 # single line. parse_line() is slow, only use it when necessary.
792 my @line = (index($line, ';') == -1)
795 # Ensure newline at the line end - necessary for
796 # correct parsing later.
799 } Text::ParseWords::parse_line(';', 1, $line);
800 foreach my $line (@line) {
804 # Join lines, but leave the "\" in place so it's clear where
805 # the original line break was.
806 chomp $complete_line;
807 $complete_line .= ' ' . $line;
809 # Line continuation, line ends with "\".
810 if ($line =~ /\\$/) {
812 # Start line continuation.
813 if (not defined $complete_line) {
814 $complete_line = $line;
819 # Use the complete line if a line continuation occurred.
820 if (defined $complete_line) {
821 $line = $complete_line;
822 $complete_line = undef;
825 # Ignore lines with no compiler commands.
826 next if not $non_verbose
827 and not $line =~ /$cc_regex_normal/o;
828 # Ignore lines with no filenames with extensions. May miss some
829 # non-verbose builds (e.g. "gcc -o test" [sic!]), but shouldn't be
830 # a problem as the log will most likely contain other non-verbose
831 # commands which are detected.
832 next if not $non_verbose
833 and not $line =~ /$file_extension_regex/o;
835 # Ignore false positives.
837 # `./configure` output.
838 next if not $non_verbose
839 and $line =~ /^(?:checking|[Cc]onfigure:) /;
840 next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
841 [Cc]ompiler[\s.]*:?\s+
843 next if $line =~ /^\s*(?:- )?(?:HOST_)?(?:CC|CXX)\s*=\s*$cc_regex_full\s*$/o;
844 # `moc-qt4`, contains '-I/usr/share/qt4/mkspecs/linux-g++' (or
845 # similar for other architectures) which gets recognized as a
846 # compiler line. Ignore it.
847 next if $line =~ m{^/usr/bin/moc-qt4
849 -I/usr/share/qt4/mkspecs/[a-z]+-g\++(?:-64)?
851 # Ignore false positives when the line contains only CC=gcc but no
853 if ($line =~ /(.*)CC=$cc_regex_full(.*)/o) {
856 next if not $before =~ /$cc_regex_normal/o
857 and not $after =~ /$cc_regex_normal/o;
860 # Check if additional hardening options were used. Used to ensure
861 # they are used for the complete build.
862 $harden_pie = 1 if any_flags_used($line, @def_cflags_pie,
864 $harden_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
867 push @input_nonverbose, $non_verbose;
873 # Ignore arch if requested.
874 if (scalar @option_ignore_arch > 0 and $arch) {
875 foreach my $ignore (@option_ignore_arch) {
876 if ($arch eq $ignore) {
877 print "ignoring architecture '$arch'\n";
883 if (scalar @input == 0) {
884 if (not $option_buildd) {
885 print "No compiler commands!\n";
886 $exit |= $exit_code{no_compiler_commands};
888 print "$buildd_tag{no_compiler_commands}||\n";
893 if ($option_buildd) {
894 $statistics{commands} += scalar @input;
897 # Option or auto detected.
899 # The following was partially copied from dpkg-dev 1.16.4.3
900 # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, add_hardening_flags()),
901 # copyright Raphaël Hertzog <hertzog@debian.org>, Kees Cook
902 # <kees@debian.org>, Canonical, Ltd. licensed under GPL version 2 or
903 # later. Keep it in sync.
906 my ($abi, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
908 # Disable unsupported hardening options.
909 if ($cpu =~ /^(?:ia64|alpha|mips|mipsel|hppa)$/ or $arch eq 'arm') {
912 if ($cpu =~ /^(?:ia64|hppa|avr32)$/) {
919 my @cflags = @def_cflags;
920 my @cxxflags = @def_cxxflags;
921 my @cppflags = @def_cppflags;
922 my @ldflags = @def_ldflags;
923 # Check the specified hardening options, same order as dpkg-buildflags.
925 @cflags = (@cflags, @def_cflags_pie);
926 @cxxflags = (@cxxflags, @def_cflags_pie);
927 @ldflags = (@ldflags, @def_ldflags_pie);
930 @cflags = (@cflags, @def_cflags_stack);
931 @cxxflags = (@cxxflags, @def_cflags_stack);
933 if ($harden_fortify) {
934 @cflags = (@cflags, @def_cflags_fortify);
935 @cxxflags = (@cxxflags, @def_cflags_fortify);
936 @cppflags = (@cppflags, @def_cppflags_fortify);
938 if ($harden_format) {
939 @cflags = (@cflags, @def_cflags_format);
940 @cxxflags = (@cxxflags, @def_cflags_format);
943 @ldflags = (@ldflags, @def_ldflags_relro);
945 if ($harden_bindnow) {
946 @ldflags = (@ldflags, @def_ldflags_bindnow);
949 # Stores normal CFLAGS when @cflags_ada are temporarily used.
952 my @cflags_ada = @cflags;
953 # Ada doesn't support format hardening flags, see #680117 for more
954 # information. Filter them out if ada is used.
955 if ($ada and $harden_format) {
958 foreach my $flag (@def_cflags_format) {
959 $ok = 0 if $_ eq $flag;
965 # Hack to fix cppflags_fortify_broken() if --ignore-flag
966 # -D_FORTIFY_SOURCE=2 is used to ignore missing fortification. Only works
967 # as long as @def_cppflags_fortify contains only one variable.
968 if (scalar @def_cppflags_fortify == 0) {
972 # Ignore flags for this arch if requested.
973 if ($arch and exists $option_ignore_arch_flag{$arch}) {
974 my @local_flag_refs = (\@cflags, \@cxxflags, \@cppflags, \@ldflags);
976 remove_flags(\@local_flag_refs,
978 @{$option_ignore_arch_flag{$arch}});
981 my @ignore_line = @option_ignore_line;
982 # Ignore lines for this arch if requested.
983 if ($arch and exists $option_ignore_arch_line{$arch}) {
984 @ignore_line = (@ignore_line, @{$option_ignore_arch_line{$arch}});
988 for (my $i = 0; $i < scalar @input; $i++) {
989 my $line = $input[$i];
991 # Ignore line if requested.
992 foreach my $ignore (@ignore_line) {
993 next LINE if $line =~ /$ignore/;
997 if ($input_nonverbose[$i]
998 and is_non_verbose_build($line, $input[$i + 1], \$skip)) {
999 if (not $option_buildd) {
1000 error_non_verbose_build($line);
1001 $exit |= $exit_code{non_verbose_build};
1003 $statistics{commands_nonverbose}++;
1007 # Even if it's a verbose build, we might have to skip this line.
1010 # Remove everything until and including the compiler command. Makes
1011 # checks easier and faster.
1012 $line =~ s/^.*?$cc_regex//o;
1013 # "([...] test.c)" is not detected as 'test.c' - fix this by removing
1014 # the brace and similar characters at the line end.
1015 $line =~ s/['")]+$//;
1017 # Skip unnecessary tests when only preprocessing.
1018 my $flag_preprocess = 0;
1025 # Preprocess, compile, assemble.
1026 if ($line =~ /\s(-E|-S|-c)\b/) {
1028 $flag_preprocess = 1 if $1 eq '-E';
1029 $compile = 1 if $1 eq '-S' or $1 eq '-c';
1030 # Dependency generation for Makefiles. The other flags (-MF -MG -MP
1031 # -MT -MQ) are always used with -M/-MM.
1032 } elsif ($line =~ /\s(?:-M|-MM)\b/) {
1034 # Otherwise assume we are linking.
1039 # -MD/-MMD also cause dependency generation, but they don't imply -E!
1040 if ($line =~ /\s(?:-MD|-MMD)\b/) {
1042 $flag_preprocess = 0;
1045 # Dependency generation for Makefiles, no preprocessing or other flags
1047 next if $dependency;
1049 # Get all file extensions on this line.
1050 my @extensions = $line =~ /$file_extension_regex/go;
1051 # Ignore all unknown extensions to speedup the search below.
1052 @extensions = grep { exists $extension{$_} } @extensions;
1054 # These file types don't require preprocessing.
1055 if (extension_found(\%extensions_no_preprocess, @extensions)) {
1058 # These file types require preprocessing.
1059 if (extension_found(\%extensions_preprocess, @extensions)) {
1063 if (not $flag_preprocess) {
1064 # If there are source files then it's compiling/linking in one
1065 # step and we must check both. We only check for source files
1066 # here, because header files cause too many false positives.
1067 if (extension_found(\%extensions_compile_link, @extensions)) {
1068 # Assembly files don't need CFLAGS.
1069 if (not extension_found(\%extensions_compile, @extensions)
1070 and extension_found(\%extensions_no_compile, @extensions)) {
1072 # But the rest does.
1076 # No compilable extensions found, either linking or compiling
1079 # If there are also no object files we are just compiling headers
1080 # (.h -> .h.gch). Don't check for linker flags in this case. Due
1081 # to our liberal checks for compiler lines, this also reduces the
1082 # number of false positives considerably.
1084 and not extension_found(\%extensions_object, @extensions)) {
1089 my $compile_cpp = 0;
1090 my $compile_ada = 0;
1091 # Assume CXXFLAGS are required when a C++ file is specified in the
1094 and extension_found(\%extensions_compile_cpp, @extensions)) {
1097 # Ada needs special CFLAGS, use them if only ada files are compiled.
1100 and array_equal(\@extensions,
1101 \@source_no_preprocess_compile_ada)) {
1103 @cflags_backup = @cflags;
1104 @cflags = @cflags_ada;
1107 if ($option_buildd) {
1108 $statistics{preprocess}++ if $preprocess;
1109 $statistics{compile}++ if $compile;
1110 $statistics{compile_cpp}++ if $compile_cpp;
1111 $statistics{link}++ if $link;
1114 # Check hardening flags.
1116 if ($compile and not all_flags_used($line, \@missing, @cflags)
1117 # Libraries linked with -fPIC don't have to (and can't) be
1118 # linked with -fPIE as well. It's no error if only PIE flags
1120 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1121 # Assume dpkg-buildflags returns the correct flags.
1122 and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
1123 if (not $option_buildd) {
1124 error_flags('CFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1125 $exit |= $exit_code{flags_missing};
1127 $statistics{compile_missing}++;
1129 } elsif ($compile_cpp and not all_flags_used($line, \@missing, @cflags)
1130 # Libraries linked with -fPIC don't have to (and can't) be
1131 # linked with -fPIE as well. It's no error if only PIE flags
1133 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1134 # Assume dpkg-buildflags returns the correct flags.
1135 and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
1136 if (not $option_buildd) {
1137 error_flags('CXXFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1138 $exit |= $exit_code{flags_missing};
1140 $statistics{compile_cpp_missing}++;
1144 and (not all_flags_used($line, \@missing, @cppflags)
1145 # The fortify flag might be overwritten, detect that.
1147 and cppflags_fortify_broken($line, \@missing)))
1148 # Assume dpkg-buildflags returns the correct flags.
1149 and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
1150 if (not $option_buildd) {
1151 error_flags('CPPFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1152 $exit |= $exit_code{flags_missing};
1154 $statistics{preprocess_missing}++;
1157 if ($link and not all_flags_used($line, \@missing, @ldflags)
1158 # Same here, -fPIC conflicts with -fPIE.
1159 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie)
1160 # Assume dpkg-buildflags returns the correct flags.
1161 and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
1162 if (not $option_buildd) {
1163 error_flags('LDFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1164 $exit |= $exit_code{flags_missing};
1166 $statistics{link_missing}++;
1170 # Restore normal CFLAGS.
1172 @cflags = @cflags_backup;
1177 # Print statistics for buildd mode, only output in this mode.
1178 if ($option_buildd) {
1181 if ($statistics{preprocess_missing}) {
1182 push @warning, sprintf 'CPPFLAGS %d (of %d)',
1183 $statistics{preprocess_missing},
1184 $statistics{preprocess};
1186 if ($statistics{compile_missing}) {
1187 push @warning, sprintf 'CFLAGS %d (of %d)',
1188 $statistics{compile_missing},
1189 $statistics{compile};
1191 if ($statistics{compile_cpp_missing}) {
1192 push @warning, sprintf 'CXXFLAGS %d (of %d)',
1193 $statistics{compile_cpp_missing},
1194 $statistics{compile_cpp};
1196 if ($statistics{link_missing}) {
1197 push @warning, sprintf 'LDFLAGS %d (of %d)',
1198 $statistics{link_missing},
1201 if (scalar @warning) {
1202 local $" = ', '; # array join string
1203 print "$buildd_tag{flags_missing}|@warning missing|\n";
1206 if ($statistics{commands_nonverbose}) {
1207 printf "$buildd_tag{non_verbose_build}|%d (of %d) hidden|\n",
1208 $statistics{commands_nonverbose},
1209 $statistics{commands},
1221 blhc - build log hardening check, checks build logs for missing hardening flags
1225 B<blhc> [I<options>] I<< <dpkg-buildpackage build log file>.. >>
1229 blhc is a small tool which checks build logs for missing hardening flags. It's
1230 licensed under the GPL 3 or later.
1232 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
1233 tools using dpkg-buildpackage like pbuilder or the official buildd build logs)
1234 to help maintainers detect missing hardening flags in their packages.
1236 Only gcc is detected as compiler at the moment. If other compilers support
1237 hardening flags as well, please report them.
1239 If there's no output, no flags are missing and the build log is fine.
1247 Force check for all +all (+pie, +bindnow) hardening flags. By default it's
1250 =item B<--arch> I<architecture>
1252 Set the specific architecture (e.g. amd64, armel, etc.), automatically
1253 disables hardening flags not available on this architecture. Is detected
1254 automatically if dpkg-buildpackage is used.
1258 Force check for all +bindnow hardening flags. By default it's auto detected.
1262 Special mode for buildds when automatically parsing log files. The following
1263 changes are in effect:
1269 Print tags instead of normal warnings, see L</"BUILDD TAGS"> for a list of
1274 Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is
1279 Don't require Term::ANSIColor.
1283 Return exit code 0, unless there was a error (-I, -W messages don't count as
1290 Use colored (ANSI) output for warning messages.
1292 =item B<--ignore-arch> I<arch>
1294 Ignore build logs from architectures matching I<arch>. I<arch> is a string.
1296 Used to prevent false positives. This option can be specified multiple times.
1298 =item B<--ignore-arch-flag> I<arch>:I<flag>
1300 Like B<--ignore-flag>, but only ignore flag on I<arch>.
1302 =item B<--ignore-arch-line> I<arch>:I<line>
1304 Like B<--ignore-line>, but only ignore line on I<arch>.
1306 =item B<--ignore-flag> I<flag>
1308 Don't print an error when the specific flag is missing in a compiler line.
1309 I<flag> is a string.
1311 Used to prevent false positives. This option can be specified multiple times.
1313 =item B<--ignore-line> I<regex>
1315 Ignore lines matching the given Perl regex. I<regex> is automatically anchored
1316 at the beginning and end of the line to prevent false negatives.
1318 B<NOTE>: Not the input lines are checked, but the lines which are displayed in
1319 warnings (which have line continuation resolved).
1321 Used to prevent false positives. This option can be specified multiple times.
1325 Force check for all +pie hardening flags. By default it's auto detected.
1327 =item B<-h -? --help>
1329 Print available options.
1333 Print version number and license.
1337 Auto detection for B<--pie> and B<--bindnow> only works if at least one
1338 command uses the required hardening flag (e.g. -fPIE). Then it's required for
1339 all other commands as well.
1343 Normal usage, parse a single log file.
1345 blhc path/to/log/file
1347 If there's no output, no flags are missing and the build log is fine.
1349 Parse multiple log files. The exit code is ORed over all files.
1351 blhc path/to/directory/with/log/files/*
1353 Don't treat missing C<-g> as error:
1355 blhc --ignore-flag -g path/to/log/file
1357 Don't treat missing C<-pie> on kfreebsd-amd64 as error:
1359 blhc --ignore-arch-flag kfreebsd-amd64:-pie path/to/log/file
1361 Ignore lines consisting exactly of C<./script gcc file> which would cause a
1364 blhc --ignore-line '\./script gcc file' path/to/log/file
1366 Ignore lines matching C<./script gcc file> somewhere in the line.
1368 blhc --ignore-line '.*\./script gcc file.*' path/to/log/file
1370 Use blhc with pbuilder.
1372 pbuilder path/to/package.dsc | tee path/log/file
1373 blhc path/to/file || echo flags missing
1377 The following tags are used in I<--buildd> mode. In braces the additional data
1382 =item B<I-hardening-wrapper-used>
1384 The package uses hardening-wrapper which intercepts calls to gcc and adds
1385 hardening flags. The build log doesn't contain any hardening flags and thus
1386 can't be checked by blhc.
1388 =item B<W-compiler-flags-hidden> (summary of hidden lines)
1390 Build log contains lines which hide the real compiler flags. For example:
1397 Most of the time either C<export V=1> or C<export verbose=1> in
1398 F<debian/rules> fixes builds with hidden compiler flags. Sometimes C<.SILENT>
1399 in a F<Makefile> must be removed. And as last resort the F<Makefile> must be
1400 patched to remove the C<@>s hiding the real compiler commands.
1402 =item B<W-dpkg-buildflags-missing> (summary of missing flags)
1404 CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
1406 =item B<I-invalid-cmake-used> (version)
1408 By default CMake ignores CPPFLAGS thus missing those hardening flags. Debian
1409 patched CMake in versions 2.8.7-1 and 2.8.7-2 to respect CPPFLAGS, but this
1410 patch was rejected by upstream and later reverted in Debian. Thus those two
1411 versions show correct usage of CPPFLAGS even if the package doesn't correctly
1412 handle them (for example by passing them to CFLAGS). To prevent false
1413 negatives just blacklist those two versions.
1415 =item B<I-no-compiler-commands>
1417 No compiler commands were detected. Either the log contains none or they were
1418 not correctly detected by blhc (please report the bug in this case).
1424 The exit status is a "bit mask", each listed status is ORed when the error
1425 condition occurs to get the result.
1435 No compiler commands were found.
1439 Invalid arguments/options given to blhc.
1447 Missing hardening flags.
1451 Hardening wrapper detected, no tests performed.
1455 Invalid CMake version used. See B<I-invalid-cmake-used> under L</"BUILDD
1456 TAGS"> for a detailed explanation.
1462 Simon Ruderich, E<lt>simon@ruderich.orgE<gt>
1464 Thanks to to Bernhard R. Link E<lt>brlink@debian.orgE<gt> and Jaria Alto
1465 E<lt>jari.aalto@cante.netE<gt> for their valuable input and suggestions.
1467 =head1 LICENSE AND COPYRIGHT
1469 Copyright (C) 2012 by Simon Ruderich
1471 This program is free software: you can redistribute it and/or modify
1472 it under the terms of the GNU General Public License as published by
1473 the Free Software Foundation, either version 3 of the License, or
1474 (at your option) any later version.
1476 This program is distributed in the hope that it will be useful,
1477 but WITHOUT ANY WARRANTY; without even the implied warranty of
1478 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1479 GNU General Public License for more details.
1481 You should have received a copy of the GNU General Public License
1482 along with this program. If not, see <http://www.gnu.org/licenses/>.
1486 L<hardening-check(1)>, L<dpkg-buildflags(1)>