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 '--param[= ]ssp-buffer-size=4' => '--param=ssp-buffer-size=4',
256 '-Wl,(?:-z,)?relro' => '-Wl,-z,relro',
257 '-Wl,(?:-z,)?now' => '-Wl,-z,now',
261 no_compiler_commands => 1 << 0,
262 # used by POD::Usage => 1 << 1,
263 non_verbose_build => 1 << 2,
264 flags_missing => 1 << 3,
265 hardening_wrapper => 1 << 4,
266 invalid_cmake => 1 << 5,
270 no_compiler_commands => 'I-no-compiler-commands',
271 non_verbose_build => 'W-compiler-flags-hidden',
272 flags_missing => 'W-dpkg-buildflags-missing',
273 hardening_wrapper => 'I-hardening-wrapper-used',
274 invalid_cmake => 'I-invalid-cmake-used',
277 # Statistics of missing flags and non-verbose build commands. Used for
281 preprocess_missing => 0,
283 compile_missing => 0,
285 compile_cpp_missing => 0,
289 commands_nonverbose => 0,
292 # Use colored (ANSI) output?
298 # Only works for single-level arrays with no undef values. Thanks to perlfaq4.
300 my ($first_ref, $second_ref) = @_;
302 return 0 if scalar @{$first_ref} != scalar @{$second_ref};
304 my $length = scalar @{$first_ref};
305 for (my $i = 0; $i < $length; $i++) {
306 return 0 if $first_ref->[$i] ne $second_ref->[$i];
313 my ($message, $missing_flags_ref, $flag_renames_ref, $line) = @_;
315 # Get string value of qr//-escaped regexps and if requested rename them.
316 my @missing_flags = map {
317 $flag_renames_ref->{$_}
318 } @{$missing_flags_ref};
320 my $flags = join ' ', @missing_flags;
321 printf '%s (%s)%s %s',
322 error_color($message, 'red'), $flags, error_color(':', 'yellow'),
327 sub error_non_verbose_build {
331 error_color('NONVERBOSE BUILD', 'red'),
332 error_color(':', 'yellow'),
337 sub error_invalid_cmake {
341 error_color('INVALID CMAKE', 'red'),
342 error_color(':', 'yellow'),
347 sub error_hardening_wrapper {
349 error_color('HARDENING WRAPPER', 'red'),
350 error_color(':', 'yellow'),
351 'no checks possible, aborting';
356 my ($message, $color) = @_;
359 return Term::ANSIColor::colored($message, $color);
366 my ($line, @flags) = @_;
368 foreach my $flag (@flags) {
369 return 1 if $line =~ /$flag/;
375 my ($line, $missing_flags_ref, @flags) = @_;
377 my @missing_flags = ();
378 foreach my $flag (@flags) {
379 if (not $line =~ /$flag/) {
380 push @missing_flags, $flag;
384 return 1 if scalar @missing_flags == 0;
386 @{$missing_flags_ref} = @missing_flags;
390 sub cppflags_fortify_broken {
391 my ($line, $missing_flags) = @_;
393 # This doesn't take the position into account, but is a simple solution.
394 # And if the build system tries to force -D_FORTIFY_SOURCE=0/1, something
397 if (any_flags_used($line, @def_cppflags_fortify_bad)) {
398 # $def_cppflags_fortify[0] must be -D_FORTIFY_SOURCE=2!
399 push @{$missing_flags}, $def_cppflags_fortify[0];
406 # Modifies $missing_flags_ref array.
407 sub pic_pie_conflict {
408 my ($line, $pie, $missing_flags_ref, @flags_pie) = @_;
410 return 0 if not $pie;
411 return 0 if not any_flags_used($line, @def_ldflags_pic);
413 my %flags = map { $_ => 1 } @flags_pie;
415 # Remove all PIE flags from @missing_flags as they are not required with
418 not exists $flags{$_}
419 } @{$missing_flags_ref};
420 @{$missing_flags_ref} = @result;
422 # We got a conflict when no flags are left, thus only PIE flags were
423 # missing. If other flags were missing abort because the conflict is not
425 return scalar @result == 0;
428 sub is_non_verbose_build {
429 my ($line, $next_line, $skip_ref) = @_;
431 if (not (index($line, 'checking if you want to see long compiling messages... no') == 0
432 or $line =~ /^\s*\[?(?:CC|CCLD|C\+\+|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/
433 or $line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
434 or $line =~ /^\s*[Bb]uilding (?:program|shared library)\s+(.+?)$/
435 or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
441 # C++ compiler setting.
442 return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
443 return 0 if $line =~ /^\s*C\+\+ Library: stdc\+\+$/;
444 # "Compiling" with no file name.
445 if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) {
446 # $file_extension_regex may need spaces around the filename.
447 return 0 if not " $1 " =~ /$file_extension_regex/o;
452 # On the first pass we only check if this line is verbose or not.
453 return 1 if not defined $next_line;
455 # Second pass, we have access to the next line.
458 # CMake and other build systems print the non-verbose messages also when
459 # building verbose. If a compiler and the file name occurs in the next
460 # line, treat it as verbose build.
462 # Get filename, we can't use the complete path as only parts of it are
463 # used in the real compiler command.
464 $file =~ m{/([^/\s]+)$};
467 if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
468 # Not a non-verbose line, but we still have to skip the current line
469 # as it doesn't contain any compiler commands.
479 my ($flag_refs_ref, $flag_renames_ref, @flags) = @_;
481 my %removes = map { $_ => 1 } @flags;
482 foreach my $flags (@{$flag_refs_ref}) {
484 # Flag found as string.
485 not exists $removes{$_}
486 # Flag found as string representation of regexp.
487 and (not defined $flag_renames_ref->{$_}
488 or not exists $removes{$flag_renames_ref->{$_}})
495 sub compile_flag_regexp {
496 my ($flag_renames_ref, @flags) = @_;
499 foreach my $flag (@flags) {
500 # Store flag name in replacement string for correct flags in messages
501 # with qr//ed flag regexps.
502 $flag_renames_ref->{qr/\s$flag(?:\s|\\)/}
503 = (exists $flag_renames_ref->{$flag})
504 ? $flag_renames_ref->{$flag}
507 # Compile flag regexp for faster execution.
508 push @result, qr/\s$flag(?:\s|\\)/;
513 sub extension_found {
514 my ($extensions_ref, @extensions) = @_;
517 foreach my $extension (@extensions) {
518 if (exists $extensions_ref->{$extension}) {
529 # Parse command line arguments.
531 my $option_version = 0;
533 my $option_bindnow = 0;
534 my @option_ignore_arch = ();
535 my @option_ignore_flag = ();
536 my @option_ignore_arch_flag = ();
537 my @option_ignore_line = ();
538 my @option_ignore_arch_line = ();
540 my $option_arch = undef;
541 my $option_buildd = 0;
543 if (not Getopt::Long::GetOptions(
544 'help|h|?' => \$option_help,
545 'version' => \$option_version,
547 'pie' => \$option_pie,
548 'bindnow' => \$option_bindnow,
549 'all' => \$option_all,
551 'ignore-arch=s' => \@option_ignore_arch,
552 'ignore-flag=s' => \@option_ignore_flag,
553 'ignore-arch-flag=s' => \@option_ignore_arch_flag,
554 'ignore-line=s' => \@option_ignore_line,
555 'ignore-arch-line=s' => \@option_ignore_arch_line,
557 'color' => \$option_color,
558 'arch=s' => \$option_arch,
559 'buildd' => \$option_buildd,
562 Pod::Usage::pod2usage(2);
566 Pod::Usage::pod2usage(1);
568 if ($option_version) {
569 print "blhc $VERSION Copyright (C) 2012 Simon Ruderich
571 This program is free software: you can redistribute it and/or modify
572 it under the terms of the GNU General Public License as published by
573 the Free Software Foundation, either version 3 of the License, or
574 (at your option) any later version.
576 This program is distributed in the hope that it will be useful,
577 but WITHOUT ANY WARRANTY; without even the implied warranty of
578 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
579 GNU General Public License for more details.
581 You should have received a copy of the GNU General Public License
582 along with this program. If not, see <http://www.gnu.org/licenses/>.
588 if (scalar @ARGV == 0) {
590 Pod::Usage::pod2usage(2);
593 # Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not
594 # installed on Debian's buildds.
595 if (not $option_buildd) {
596 require Term::ANSIColor;
604 # Precompiled ignores for faster lookup.
605 my %option_ignore_arch_flag = ();
606 my %option_ignore_arch_line = ();
608 # Strip flags which should be ignored.
609 if (scalar @option_ignore_flag > 0) {
610 remove_flags(\@flag_refs, \%flag_renames, @option_ignore_flag);
612 # Same for arch specific ignore flags, but only prepare here.
613 if (scalar @option_ignore_arch_flag > 0) {
614 foreach my $ignore (@option_ignore_arch_flag) {
615 my ($ignore_arch, $ignore_flag) = split /:/, $ignore, 2;
617 if (not $ignore_arch or not $ignore_flag) {
618 printf STDERR 'Value "%s" invalid for option ignore-arch-flag '
619 . '("arch:flag" expected)' . "\n", $ignore;
621 Pod::Usage::pod2usage(2);
624 push @{$option_ignore_arch_flag{$ignore_arch}}, $ignore_flag;
628 # Precompile all flag regexps. any_flags_used(), all_flags_used() get a lot
630 foreach my $flags (@flag_refs_all) {
631 @{$flags} = compile_flag_regexp(\%flag_renames, @{$flags});
634 # Precompile ignore line regexps, also anchor at beginning and end of line.
635 foreach my $ignore (@option_ignore_line) {
636 $ignore = qr/^$ignore$/;
638 # Same for arch specific ignore lines.
639 if (scalar @option_ignore_arch_line > 0) {
640 foreach my $ignore (@option_ignore_arch_line) {
641 my ($ignore_arch, $ignore_line) = split /:/, $ignore, 2;
643 if (not $ignore_arch or not $ignore_line) {
644 printf STDERR 'Value "%s" invalid for option ignore-arch-line '
645 . '("arch:line" expected)' . "\n", $ignore;
647 Pod::Usage::pod2usage(2);
650 push @{$option_ignore_arch_line{$ignore_arch}}, qr/^$ignore_line$/;
658 foreach my $file (@ARGV) {
659 print "checking '$file'...\n" if scalar @ARGV > 1;
661 -f $file or die "No such file: $file";
663 open my $fh, '<', $file or die $!;
665 # Architecture of this file.
666 my $arch = $option_arch;
668 # Hardening options. Not all architectures support all hardening options.
669 my $harden_format = 1;
670 my $harden_fortify = 1;
671 my $harden_stack = 1;
672 my $harden_relro = 1;
673 my $harden_bindnow = $option_bindnow; # defaults to 0
674 my $harden_pie = $option_pie; # defaults to 0
676 # Does this build log use ada? Ada also uses gcc as compiler but uses
677 # different CFLAGS. But only perform ada checks if an ada compiler used
678 # for performance reasons.
681 while (my $line = <$fh>) {
682 # Detect architecture automatically unless overridden. For buildd logs
683 # only, doesn't use the dpkg-buildpackage header. Necessary to ignore
684 # build logs which aren't built (wrong architecture, build error,
686 if (not $arch and index($line, 'Architecture: ') == 0) {
687 $arch = substr $line, 14, -1; # -1 to ignore '\n' at the end
690 # dpkg-buildflags only provides hardening flags since 1.16.1, don't
691 # check for hardening flags in buildd mode if an older dpkg-dev is
692 # used. Default flags (-g -O2) are still checked.
694 # Packages which were built before 1.16.1 but used their own hardening
695 # flags are not checked.
697 and index($line, 'Toolchain package versions: ') == 0) {
698 require Dpkg::Version;
699 if (not $line =~ /\bdpkg-dev_(\S+)/
700 or Dpkg::Version::version_compare($1, '1.16.1') < 0) {
710 # The following two versions of CMake in Debian obeyed CPPFLAGS, but
711 # this was later dropped because upstream rejected the patch. Thus
712 # build logs with these versions will have fortify hardening flags
713 # enabled, even though they may be not correctly set and are missing
714 # when build with later CMake versions. Thanks to Aron Xu for letting
716 if (index($line, 'Package versions: ') == 0
717 and $line =~ /\bcmake_(\S+)/
718 and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
719 if (not $option_buildd) {
720 error_invalid_cmake($1);
721 $exit |= $exit_code{invalid_cmake};
723 print "$buildd_tag{invalid_cmake}|$1|\n";
727 # Debian's build daemons use Build-Depends: for the build
728 # dependencies, but pbuilder just uses Depends:; support both.
729 if (index($line, 'Build-Depends: ') == 0
730 or index($line, 'Depends: ') == 0) {
731 # If hardening wrapper is used (wraps calls to gcc and adds
732 # hardening flags automatically) we can't perform any checks,
734 if ($line =~ /\bhardening-wrapper\b/) {
735 if (not $option_buildd) {
736 error_hardening_wrapper();
737 $exit |= $exit_code{hardening_wrapper};
739 print "$buildd_tag{hardening_wrapper}||\n";
745 if ($line =~ /\bgnat\b/) {
750 # We skip over unimportant lines at the beginning of the log to
751 # prevent false positives.
752 last if index($line, 'dpkg-buildpackage: ') == 0;
755 # Input lines, contain only the lines with compiler commands.
757 # Non-verbose lines in the input. Used to reduce calls to
758 # is_non_verbose_build() (which is quite slow) in the second loop when
759 # it's already clear if a line is non-verbose or not.
760 my @input_nonverbose = ();
762 my $continuation = 0;
763 my $complete_line = undef;
764 while (my $line = <$fh>) {
765 # And stop at the end of the build log. Package details (reported by
766 # the buildd logs) are not important for us. This also prevents false
768 last if index($line, 'Build finished at ') == 0
769 and $line =~ /^Build finished at \d{8}-\d{4}$/;
771 # Detect architecture automatically unless overridden.
773 and index($line, 'dpkg-buildpackage: host architecture ') == 0) {
774 $arch = substr $line, 37, -1; # -1 to ignore '\n' at the end
776 # Old buildd logs use e.g. "host architecture is alpha", remove
777 # the "is", otherwise debarch_to_debtriplet() will not detect the
779 if (index($arch, 'is ') == 0) {
780 $arch = substr $arch, 3;
784 # Ignore compiler warnings for now.
785 next if $line =~ /$warning_regex/o;
787 if (not $option_buildd and index($line, "\033") != -1) { # \033 = esc
788 # Remove all ANSI color sequences which are sometimes used in
789 # non-verbose builds.
790 $line = Term::ANSIColor::colorstrip($line);
791 # Also strip '\0xf' (delete previous character), used by Elinks'
794 # And "ESC(B" which seems to be used on armhf and hurd (not sure
796 $line =~ s/\033\(B//g;
799 # Check if this line indicates a non verbose build.
800 my $non_verbose = is_non_verbose_build($line);
802 # One line may contain multiple commands (";"). Treat each one as
803 # single line. parse_line() is slow, only use it when necessary.
804 my @line = (index($line, ';') == -1)
807 # Ensure newline at the line end - necessary for
808 # correct parsing later.
811 } Text::ParseWords::parse_line(';', 1, $line);
812 foreach my $line (@line) {
816 # Join lines, but leave the "\" in place so it's clear where
817 # the original line break was.
818 chomp $complete_line;
819 $complete_line .= ' ' . $line;
821 # Line continuation, line ends with "\".
822 if ($line =~ /\\$/) {
824 # Start line continuation.
825 if (not defined $complete_line) {
826 $complete_line = $line;
831 # Use the complete line if a line continuation occurred.
832 if (defined $complete_line) {
833 $line = $complete_line;
834 $complete_line = undef;
837 # Ignore lines with no compiler commands.
838 next if not $non_verbose
839 and not $line =~ /$cc_regex_normal/o;
840 # Ignore lines with no filenames with extensions. May miss some
841 # non-verbose builds (e.g. "gcc -o test" [sic!]), but shouldn't be
842 # a problem as the log will most likely contain other non-verbose
843 # commands which are detected.
844 next if not $non_verbose
845 and not $line =~ /$file_extension_regex/o;
847 # Ignore false positives.
849 # `./configure` output.
850 next if not $non_verbose
851 and $line =~ /^(?:checking|[Cc]onfigure:) /;
852 next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
853 [Cc]ompiler[\s.]*:?\s+
855 next if $line =~ /^\s*(?:- )?(?:HOST_)?(?:CC|CXX)\s*=\s*$cc_regex_full\s*$/o;
856 # `moc-qt4`/`moc-qt5` contain '-I.../linux-g++' in their command
857 # line (or similar for other architectures) which gets recognized
858 # as a compiler line, but `moc-qt*` is only a preprocessor for Qt
859 # C++ files. No hardening flags are relevant during this step,
860 # thus ignore `moc-qt*` lines. The resulting files will be
861 # compiled in a separate step (and therefore checked).
862 next if $line =~ m{^\S+/bin/moc-qt[45]
864 -I\S+/mkspecs/[a-z]+-g\++(?:-64)?
866 # Ignore false positives when the line contains only CC=gcc but no
868 if ($line =~ /(.*)CC=$cc_regex_full(.*)/o) {
871 next if not $before =~ /$cc_regex_normal/o
872 and not $after =~ /$cc_regex_normal/o;
875 # Check if additional hardening options were used. Used to ensure
876 # they are used for the complete build.
877 $harden_pie = 1 if any_flags_used($line, @def_cflags_pie,
879 $harden_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
882 push @input_nonverbose, $non_verbose;
888 # Ignore arch if requested.
889 if (scalar @option_ignore_arch > 0 and $arch) {
890 foreach my $ignore (@option_ignore_arch) {
891 if ($arch eq $ignore) {
892 print "ignoring architecture '$arch'\n";
898 if (scalar @input == 0) {
899 if (not $option_buildd) {
900 print "No compiler commands!\n";
901 $exit |= $exit_code{no_compiler_commands};
903 print "$buildd_tag{no_compiler_commands}||\n";
908 if ($option_buildd) {
909 $statistics{commands} += scalar @input;
912 # Option or auto detected.
914 # The following was partially copied from dpkg-dev 1.16.4.3
915 # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, add_hardening_flags()),
916 # copyright Raphaël Hertzog <hertzog@debian.org>, Kees Cook
917 # <kees@debian.org>, Canonical, Ltd. licensed under GPL version 2 or
918 # later. Keep it in sync.
921 my ($abi, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
923 # Disable unsupported hardening options.
924 if ($cpu =~ /^(?:ia64|alpha|mips|mipsel|hppa)$/ or $arch eq 'arm') {
927 if ($cpu =~ /^(?:ia64|hppa|avr32)$/) {
934 my @cflags = @def_cflags;
935 my @cxxflags = @def_cxxflags;
936 my @cppflags = @def_cppflags;
937 my @ldflags = @def_ldflags;
938 # Check the specified hardening options, same order as dpkg-buildflags.
940 @cflags = (@cflags, @def_cflags_pie);
941 @cxxflags = (@cxxflags, @def_cflags_pie);
942 @ldflags = (@ldflags, @def_ldflags_pie);
945 @cflags = (@cflags, @def_cflags_stack);
946 @cxxflags = (@cxxflags, @def_cflags_stack);
948 if ($harden_fortify) {
949 @cflags = (@cflags, @def_cflags_fortify);
950 @cxxflags = (@cxxflags, @def_cflags_fortify);
951 @cppflags = (@cppflags, @def_cppflags_fortify);
953 if ($harden_format) {
954 @cflags = (@cflags, @def_cflags_format);
955 @cxxflags = (@cxxflags, @def_cflags_format);
958 @ldflags = (@ldflags, @def_ldflags_relro);
960 if ($harden_bindnow) {
961 @ldflags = (@ldflags, @def_ldflags_bindnow);
964 # Stores normal CFLAGS when @cflags_ada are temporarily used.
967 my @cflags_ada = @cflags;
968 # Ada doesn't support format hardening flags, see #680117 for more
969 # information. Filter them out if ada is used.
970 if ($ada and $harden_format) {
973 foreach my $flag (@def_cflags_format) {
974 $ok = 0 if $_ eq $flag;
980 # Hack to fix cppflags_fortify_broken() if --ignore-flag
981 # -D_FORTIFY_SOURCE=2 is used to ignore missing fortification. Only works
982 # as long as @def_cppflags_fortify contains only one variable.
983 if (scalar @def_cppflags_fortify == 0) {
987 # Ignore flags for this arch if requested.
988 if ($arch and exists $option_ignore_arch_flag{$arch}) {
989 my @local_flag_refs = (\@cflags, \@cxxflags, \@cppflags, \@ldflags);
991 remove_flags(\@local_flag_refs,
993 @{$option_ignore_arch_flag{$arch}});
996 my @ignore_line = @option_ignore_line;
997 # Ignore lines for this arch if requested.
998 if ($arch and exists $option_ignore_arch_line{$arch}) {
999 @ignore_line = (@ignore_line, @{$option_ignore_arch_line{$arch}});
1003 for (my $i = 0; $i < scalar @input; $i++) {
1004 my $line = $input[$i];
1006 # Ignore line if requested.
1007 foreach my $ignore (@ignore_line) {
1008 next LINE if $line =~ /$ignore/;
1012 if ($input_nonverbose[$i]
1013 and is_non_verbose_build($line, $input[$i + 1], \$skip)) {
1014 if (not $option_buildd) {
1015 error_non_verbose_build($line);
1016 $exit |= $exit_code{non_verbose_build};
1018 $statistics{commands_nonverbose}++;
1022 # Even if it's a verbose build, we might have to skip this line.
1025 # Remove everything until and including the compiler command. Makes
1026 # checks easier and faster.
1027 $line =~ s/^.*?$cc_regex//o;
1028 # "([...] test.c)" is not detected as 'test.c' - fix this by removing
1029 # the brace and similar characters at the line end.
1030 $line =~ s/['")]+$//;
1032 # Skip unnecessary tests when only preprocessing.
1033 my $flag_preprocess = 0;
1040 # Preprocess, compile, assemble.
1041 if ($line =~ /\s(-E|-S|-c)\b/) {
1043 $flag_preprocess = 1 if $1 eq '-E';
1044 $compile = 1 if $1 eq '-S' or $1 eq '-c';
1045 # Dependency generation for Makefiles. The other flags (-MF -MG -MP
1046 # -MT -MQ) are always used with -M/-MM.
1047 } elsif ($line =~ /\s(?:-M|-MM)\b/) {
1049 # Otherwise assume we are linking.
1054 # -MD/-MMD also cause dependency generation, but they don't imply -E!
1055 if ($line =~ /\s(?:-MD|-MMD)\b/) {
1057 $flag_preprocess = 0;
1060 # Dependency generation for Makefiles, no preprocessing or other flags
1062 next if $dependency;
1064 # Get all file extensions on this line.
1065 my @extensions = $line =~ /$file_extension_regex/go;
1066 # Ignore all unknown extensions to speedup the search below.
1067 @extensions = grep { exists $extension{$_} } @extensions;
1069 # These file types don't require preprocessing.
1070 if (extension_found(\%extensions_no_preprocess, @extensions)) {
1073 # These file types require preprocessing.
1074 if (extension_found(\%extensions_preprocess, @extensions)) {
1078 if (not $flag_preprocess) {
1079 # If there are source files then it's compiling/linking in one
1080 # step and we must check both. We only check for source files
1081 # here, because header files cause too many false positives.
1082 if (extension_found(\%extensions_compile_link, @extensions)) {
1083 # Assembly files don't need CFLAGS.
1084 if (not extension_found(\%extensions_compile, @extensions)
1085 and extension_found(\%extensions_no_compile, @extensions)) {
1087 # But the rest does.
1091 # No compilable extensions found, either linking or compiling
1094 # If there are also no object files we are just compiling headers
1095 # (.h -> .h.gch). Don't check for linker flags in this case. Due
1096 # to our liberal checks for compiler lines, this also reduces the
1097 # number of false positives considerably.
1099 and not extension_found(\%extensions_object, @extensions)) {
1104 my $compile_cpp = 0;
1105 my $compile_ada = 0;
1106 # Assume CXXFLAGS are required when a C++ file is specified in the
1109 and extension_found(\%extensions_compile_cpp, @extensions)) {
1112 # Ada needs special CFLAGS, use them if only ada files are compiled.
1115 and array_equal(\@extensions,
1116 \@source_no_preprocess_compile_ada)) {
1118 @cflags_backup = @cflags;
1119 @cflags = @cflags_ada;
1122 if ($option_buildd) {
1123 $statistics{preprocess}++ if $preprocess;
1124 $statistics{compile}++ if $compile;
1125 $statistics{compile_cpp}++ if $compile_cpp;
1126 $statistics{link}++ if $link;
1129 # Check hardening flags.
1131 if ($compile and not all_flags_used($line, \@missing, @cflags)
1132 # Libraries linked with -fPIC don't have to (and can't) be
1133 # linked with -fPIE as well. It's no error if only PIE flags
1135 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1136 # Assume dpkg-buildflags returns the correct flags.
1137 and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
1138 if (not $option_buildd) {
1139 error_flags('CFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1140 $exit |= $exit_code{flags_missing};
1142 $statistics{compile_missing}++;
1144 } elsif ($compile_cpp and not all_flags_used($line, \@missing, @cflags)
1145 # Libraries linked with -fPIC don't have to (and can't) be
1146 # linked with -fPIE as well. It's no error if only PIE flags
1148 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1149 # Assume dpkg-buildflags returns the correct flags.
1150 and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
1151 if (not $option_buildd) {
1152 error_flags('CXXFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1153 $exit |= $exit_code{flags_missing};
1155 $statistics{compile_cpp_missing}++;
1159 and (not all_flags_used($line, \@missing, @cppflags)
1160 # The fortify flag might be overwritten, detect that.
1162 and cppflags_fortify_broken($line, \@missing)))
1163 # Assume dpkg-buildflags returns the correct flags.
1164 and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
1165 if (not $option_buildd) {
1166 error_flags('CPPFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1167 $exit |= $exit_code{flags_missing};
1169 $statistics{preprocess_missing}++;
1172 if ($link and not all_flags_used($line, \@missing, @ldflags)
1173 # Same here, -fPIC conflicts with -fPIE.
1174 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie)
1175 # Assume dpkg-buildflags returns the correct flags.
1176 and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
1177 if (not $option_buildd) {
1178 error_flags('LDFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1179 $exit |= $exit_code{flags_missing};
1181 $statistics{link_missing}++;
1185 # Restore normal CFLAGS.
1187 @cflags = @cflags_backup;
1192 # Print statistics for buildd mode, only output in this mode.
1193 if ($option_buildd) {
1196 if ($statistics{preprocess_missing}) {
1197 push @warning, sprintf 'CPPFLAGS %d (of %d)',
1198 $statistics{preprocess_missing},
1199 $statistics{preprocess};
1201 if ($statistics{compile_missing}) {
1202 push @warning, sprintf 'CFLAGS %d (of %d)',
1203 $statistics{compile_missing},
1204 $statistics{compile};
1206 if ($statistics{compile_cpp_missing}) {
1207 push @warning, sprintf 'CXXFLAGS %d (of %d)',
1208 $statistics{compile_cpp_missing},
1209 $statistics{compile_cpp};
1211 if ($statistics{link_missing}) {
1212 push @warning, sprintf 'LDFLAGS %d (of %d)',
1213 $statistics{link_missing},
1216 if (scalar @warning) {
1217 local $" = ', '; # array join string
1218 print "$buildd_tag{flags_missing}|@warning missing|\n";
1221 if ($statistics{commands_nonverbose}) {
1222 printf "$buildd_tag{non_verbose_build}|%d (of %d) hidden|\n",
1223 $statistics{commands_nonverbose},
1224 $statistics{commands},
1236 blhc - build log hardening check, checks build logs for missing hardening flags
1240 B<blhc> [I<options>] I<< <dpkg-buildpackage build log file>.. >>
1244 blhc is a small tool which checks build logs for missing hardening flags. It's
1245 licensed under the GPL 3 or later.
1247 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
1248 tools using dpkg-buildpackage like pbuilder or the official buildd build logs)
1249 to help maintainers detect missing hardening flags in their packages.
1251 Only gcc is detected as compiler at the moment. If other compilers support
1252 hardening flags as well, please report them.
1254 If there's no output, no flags are missing and the build log is fine.
1262 Force check for all +all (+pie, +bindnow) hardening flags. By default it's
1265 =item B<--arch> I<architecture>
1267 Set the specific architecture (e.g. amd64, armel, etc.), automatically
1268 disables hardening flags not available on this architecture. Is detected
1269 automatically if dpkg-buildpackage is used.
1273 Force check for all +bindnow hardening flags. By default it's auto detected.
1277 Special mode for buildds when automatically parsing log files. The following
1278 changes are in effect:
1284 Print tags instead of normal warnings, see L</"BUILDD TAGS"> for a list of
1289 Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is
1294 Don't require Term::ANSIColor.
1298 Return exit code 0, unless there was a error (-I, -W messages don't count as
1305 Use colored (ANSI) output for warning messages.
1307 =item B<--ignore-arch> I<arch>
1309 Ignore build logs from architectures matching I<arch>. I<arch> is a string.
1311 Used to prevent false positives. This option can be specified multiple times.
1313 =item B<--ignore-arch-flag> I<arch>:I<flag>
1315 Like B<--ignore-flag>, but only ignore flag on I<arch>.
1317 =item B<--ignore-arch-line> I<arch>:I<line>
1319 Like B<--ignore-line>, but only ignore line on I<arch>.
1321 =item B<--ignore-flag> I<flag>
1323 Don't print an error when the specific flag is missing in a compiler line.
1324 I<flag> is a string.
1326 Used to prevent false positives. This option can be specified multiple times.
1328 =item B<--ignore-line> I<regex>
1330 Ignore lines matching the given Perl regex. I<regex> is automatically anchored
1331 at the beginning and end of the line to prevent false negatives.
1333 B<NOTE>: Not the input lines are checked, but the lines which are displayed in
1334 warnings (which have line continuation resolved).
1336 Used to prevent false positives. This option can be specified multiple times.
1340 Force check for all +pie hardening flags. By default it's auto detected.
1342 =item B<-h -? --help>
1344 Print available options.
1348 Print version number and license.
1352 Auto detection for B<--pie> and B<--bindnow> only works if at least one
1353 command uses the required hardening flag (e.g. -fPIE). Then it's required for
1354 all other commands as well.
1358 Normal usage, parse a single log file.
1360 blhc path/to/log/file
1362 If there's no output, no flags are missing and the build log is fine.
1364 Parse multiple log files. The exit code is ORed over all files.
1366 blhc path/to/directory/with/log/files/*
1368 Don't treat missing C<-g> as error:
1370 blhc --ignore-flag -g path/to/log/file
1372 Don't treat missing C<-pie> on kfreebsd-amd64 as error:
1374 blhc --ignore-arch-flag kfreebsd-amd64:-pie path/to/log/file
1376 Ignore lines consisting exactly of C<./script gcc file> which would cause a
1379 blhc --ignore-line '\./script gcc file' path/to/log/file
1381 Ignore lines matching C<./script gcc file> somewhere in the line.
1383 blhc --ignore-line '.*\./script gcc file.*' path/to/log/file
1385 Use blhc with pbuilder.
1387 pbuilder path/to/package.dsc | tee path/log/file
1388 blhc path/to/file || echo flags missing
1392 The following tags are used in I<--buildd> mode. In braces the additional data
1397 =item B<I-hardening-wrapper-used>
1399 The package uses hardening-wrapper which intercepts calls to gcc and adds
1400 hardening flags. The build log doesn't contain any hardening flags and thus
1401 can't be checked by blhc.
1403 =item B<W-compiler-flags-hidden> (summary of hidden lines)
1405 Build log contains lines which hide the real compiler flags. For example:
1412 Most of the time either C<export V=1> or C<export verbose=1> in
1413 F<debian/rules> fixes builds with hidden compiler flags. Sometimes C<.SILENT>
1414 in a F<Makefile> must be removed. And as last resort the F<Makefile> must be
1415 patched to remove the C<@>s hiding the real compiler commands.
1417 =item B<W-dpkg-buildflags-missing> (summary of missing flags)
1419 CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
1421 =item B<I-invalid-cmake-used> (version)
1423 By default CMake ignores CPPFLAGS thus missing those hardening flags. Debian
1424 patched CMake in versions 2.8.7-1 and 2.8.7-2 to respect CPPFLAGS, but this
1425 patch was rejected by upstream and later reverted in Debian. Thus those two
1426 versions show correct usage of CPPFLAGS even if the package doesn't correctly
1427 handle them (for example by passing them to CFLAGS). To prevent false
1428 negatives just blacklist those two versions.
1430 =item B<I-no-compiler-commands>
1432 No compiler commands were detected. Either the log contains none or they were
1433 not correctly detected by blhc (please report the bug in this case).
1439 The exit status is a "bit mask", each listed status is ORed when the error
1440 condition occurs to get the result.
1450 No compiler commands were found.
1454 Invalid arguments/options given to blhc.
1462 Missing hardening flags.
1466 Hardening wrapper detected, no tests performed.
1470 Invalid CMake version used. See B<I-invalid-cmake-used> under L</"BUILDD
1471 TAGS"> for a detailed explanation.
1477 Simon Ruderich, E<lt>simon@ruderich.orgE<gt>
1479 Thanks to to Bernhard R. Link E<lt>brlink@debian.orgE<gt> and Jaria Alto
1480 E<lt>jari.aalto@cante.netE<gt> for their valuable input and suggestions.
1482 =head1 LICENSE AND COPYRIGHT
1484 Copyright (C) 2012 by Simon Ruderich
1486 This program is free software: you can redistribute it and/or modify
1487 it under the terms of the GNU General Public License as published by
1488 the Free Software Foundation, either version 3 of the License, or
1489 (at your option) any later version.
1491 This program is distributed in the hope that it will be useful,
1492 but WITHOUT ANY WARRANTY; without even the implied warranty of
1493 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1494 GNU General Public License for more details.
1496 You should have received a copy of the GNU General Public License
1497 along with this program. If not, see <http://www.gnu.org/licenses/>.
1501 L<hardening-check(1)>, L<dpkg-buildflags(1)>