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.02';
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 ),
106 # Hashes for fast extensions lookup to check if a file falls in one of these
108 my %extensions_no_preprocess = map { $_ => 1 } (
109 @source_no_preprocess,
111 my %extensions_preprocess = map { $_ => 1 } (
115 my %extensions_compile_link = map { $_ => 1 } (
117 @source_no_preprocess,
119 my %extensions_compile = map { $_ => 1 } (
120 @source_preprocess_compile,
121 @source_no_preprocess_compile,
123 my %extensions_no_compile = map { $_ => 1 } (
124 @source_preprocess_no_compile,
125 @source_no_preprocess_no_compile,
127 my %extensions_compile_cpp = map { $_ => 1 } (
128 @source_preprocess_compile_cpp,
129 @source_no_preprocess_compile_cpp,
131 my %extension = map { $_ => 1 } (
132 @source_no_preprocess,
137 # Regexp to match file extensions.
138 my $file_extension_regex = qr/
140 \S+ # Filename without extension.
142 ([^\/\\.,;:\s]+)# File extension.
143 (?=\s|\\) # At end of word. Can't use \b because some files have non
144 # word characters at the end and because \b matches double
145 # extensions (like .cpp.o). Works always as all lines are
146 # terminated with "\n".
149 # Expected (hardening) flags. All flags are used as regexps.
154 my @def_cflags_format = (
156 '-Werror=format-security', # implies -Wformat-security
158 my @def_cflags_fortify = (
159 # fortify needs at least -O1, but -O2 is recommended anyway
161 my @def_cflags_stack = (
163 '--param=ssp-buffer-size=4',
165 my @def_cflags_pie = (
171 # @def_cxxflags_* is the same as @def_cflags_*.
172 my @def_cppflags = ();
173 my @def_cppflags_fortify = (
174 '-D_FORTIFY_SOURCE=2',
176 my @def_ldflags = ();
177 my @def_ldflags_relro = (
180 my @def_ldflags_bindnow = (
183 my @def_ldflags_pie = (
187 my @def_ldflags_pic = (
192 # References to all flags checked by the parser.
196 \@def_cflags_fortify,
201 \@def_cppflags_fortify,
204 \@def_ldflags_bindnow,
207 # References to all used flags.
208 my @flag_refs_all = (
212 # Renaming rules for the output so the regex parts are not visible. Also
213 # stores string values of flag regexps above, see compile_flag_regexp().
215 '-O(?:2|3)' => '-O2',
216 '-Wl,(?:-z,)?relro' => '-Wl,-z,relro',
217 '-Wl,(?:-z,)?now' => '-Wl,-z,now',
221 no_compiler_commands => 1 << 0,
222 # used by POD::Usage => 1 << 1,
223 non_verbose_build => 1 << 2,
224 flags_missing => 1 << 3,
225 hardening_wrapper => 1 << 4,
226 invalid_cmake => 1 << 5,
230 no_compiler_commands => 'I-no-compiler-commands',
231 non_verbose_build => 'W-compiler-flags-hidden',
232 flags_missing => 'W-dpkg-buildflags-missing',
233 hardening_wrapper => 'I-hardening-wrapper-used',
234 invalid_cmake => 'I-invalid-cmake-used',
237 # Statistics of missing flags and non-verbose build commands. Used for
241 preprocess_missing => 0,
243 compile_missing => 0,
245 compile_cpp_missing => 0,
249 commands_nonverbose => 0,
252 # Use colored (ANSI) output?
259 my ($message, $missing_flags_ref, $flag_renames_ref, $line) = @_;
261 # Get string value of qr//-escaped regexps and if requested rename them.
262 my @missing_flags = map {
263 $flag_renames_ref->{$_}
264 } @{$missing_flags_ref};
266 my $flags = join ' ', @missing_flags;
267 printf '%s (%s)%s %s',
268 error_color($message, 'red'), $flags, error_color(':', 'yellow'),
271 sub error_non_verbose_build {
275 error_color('NONVERBOSE BUILD', 'red'),
276 error_color(':', 'yellow'),
279 sub error_invalid_cmake {
283 error_color('INVALID CMAKE', 'red'),
284 error_color(':', 'yellow'),
287 sub error_hardening_wrapper {
289 error_color('HARDENING WRAPPER', 'red'),
290 error_color(':', 'yellow'),
291 'no checks possible, aborting';
294 my ($message, $color) = @_;
297 return Term::ANSIColor::colored($message, $color);
304 my ($line, @flags) = @_;
306 foreach my $flag (@flags) {
307 return 1 if $line =~ /$flag/;
313 my ($line, $missing_flags_ref, @flags) = @_;
315 my @missing_flags = ();
316 foreach my $flag (@flags) {
317 if (not $line =~ /$flag/) {
318 push @missing_flags, $flag;
322 return 1 if scalar @missing_flags == 0;
324 @{$missing_flags_ref} = @missing_flags;
328 # Modifies $missing_flags_ref array.
329 sub pic_pie_conflict {
330 my ($line, $pie, $missing_flags_ref, @flags_pie) = @_;
332 return 0 if not $pie;
333 return 0 if not any_flags_used($line, @def_ldflags_pic);
335 my %flags = map { $_ => 1 } @flags_pie;
337 # Remove all PIE flags from @missing_flags as they are not required with
340 not exists $flags{$_}
341 } @{$missing_flags_ref};
342 @{$missing_flags_ref} = @result;
344 # We got a conflict when no flags are left, thus only PIE flags were
345 # missing. If other flags were missing abort because the conflict is not
347 return scalar @result == 0;
350 sub is_non_verbose_build {
351 my ($line, $next_line, $skip_ref) = @_;
353 if (not (index($line, 'checking if you want to see long compiling messages... no') == 0
354 or $line =~ /^\s*\[?(?:CC|CCLD|C\+\+|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/
355 or $line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
356 or $line =~ /^\s*[Bb]uilding (?:program|shared library)\s+(.+?)$/
357 or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
363 # C++ compiler setting.
364 return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
365 # "Compiling" with no file name.
366 if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) {
367 # $file_extension_regex may need spaces around the filename.
368 return 0 if not " $1 " =~ /$file_extension_regex/o;
373 # On the first pass we only check if this line is verbose or not.
374 return 1 if not defined $next_line;
376 # Second pass, we have access to the next line.
379 # CMake and other build systems print the non-verbose messages also when
380 # building verbose. If a compiler and the file name occurs in the next
381 # line, treat it as verbose build.
383 # Get filename, we can't use the complete path as only parts of it are
384 # used in the real compiler command.
385 $file =~ m{/([^/\s]+)$};
388 if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
389 # We still have to skip the current line as it doesn't contain any
400 my ($flag_refs_ref, $flag_renames_ref, @flags) = @_;
402 my %removes = map { $_ => 1 } @flags;
403 foreach my $flags (@{$flag_refs_ref}) {
405 # Flag found as string.
406 not exists $removes{$_}
407 # Flag found as string representation of regexp.
408 and (not defined $flag_renames_ref->{$_}
409 or not exists $removes{$flag_renames_ref->{$_}})
414 sub compile_flag_regexp {
415 my ($flag_renames_ref, @flags) = @_;
418 foreach my $flag (@flags) {
419 # Store flag name in replacement string for correct flags in messages
420 # with qr//ed flag regexps.
421 $flag_renames_ref->{qr/\s$flag(?:\s|\\)/}
422 = (exists $flag_renames_ref->{$flag})
423 ? $flag_renames_ref->{$flag}
426 # Compile flag regexp for faster execution.
427 push @result, qr/\s$flag(?:\s|\\)/;
432 sub extension_found {
433 my ($extensions_ref, @extensions) = @_;
436 foreach my $extension (@extensions) {
437 if (exists $extensions_ref->{$extension}) {
448 # Parse command line arguments.
450 my $option_version = 0;
452 my $option_bindnow = 0;
453 my @option_ignore_arch = ();
454 my @option_ignore_flag = ();
455 my @option_ignore_arch_flag = ();
456 my @option_ignore_line = ();
457 my @option_ignore_arch_line = ();
459 my $option_arch = undef;
460 my $option_buildd = 0;
462 if (not Getopt::Long::GetOptions(
463 'help|h|?' => \$option_help,
464 'version' => \$option_version,
466 'pie' => \$option_pie,
467 'bindnow' => \$option_bindnow,
468 'all' => \$option_all,
470 'ignore-arch=s' => \@option_ignore_arch,
471 'ignore-flag=s' => \@option_ignore_flag,
472 'ignore-arch-flag=s' => \@option_ignore_arch_flag,
473 'ignore-line=s' => \@option_ignore_line,
474 'ignore-arch-line=s' => \@option_ignore_arch_line,
476 'color' => \$option_color,
477 'arch=s' => \$option_arch,
478 'buildd' => \$option_buildd,
481 Pod::Usage::pod2usage(2);
485 Pod::Usage::pod2usage(1);
487 if ($option_version) {
488 print "blhc $VERSION Copyright (C) 2012 Simon Ruderich
490 This program is free software: you can redistribute it and/or modify
491 it under the terms of the GNU General Public License as published by
492 the Free Software Foundation, either version 3 of the License, or
493 (at your option) any later version.
495 This program is distributed in the hope that it will be useful,
496 but WITHOUT ANY WARRANTY; without even the implied warranty of
497 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
498 GNU General Public License for more details.
500 You should have received a copy of the GNU General Public License
501 along with this program. If not, see <http://www.gnu.org/licenses/>.
507 if (scalar @ARGV == 0) {
509 Pod::Usage::pod2usage(2);
512 # Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not
513 # installed on Debian's buildds.
514 if (not $option_buildd) {
515 require Term::ANSIColor;
523 # Precompiled ignores for faster lookup.
524 my %option_ignore_arch_flag = ();
525 my %option_ignore_arch_line = ();
527 # Strip flags which should be ignored.
528 if (scalar @option_ignore_flag > 0) {
529 remove_flags(\@flag_refs, \%flag_renames, @option_ignore_flag);
531 # Same for arch specific ignore flags, but only prepare here.
532 if (scalar @option_ignore_arch_flag > 0) {
533 foreach my $ignore (@option_ignore_arch_flag) {
534 my ($ignore_arch, $ignore_flag) = split ':', $ignore, 2;
536 if (not $ignore_arch or not $ignore_flag) {
537 printf STDERR 'Value "%s" invalid for option ignore-arch-flag '
538 . '("arch:flag" expected)' . "\n", $ignore;
540 Pod::Usage::pod2usage(2);
543 push @{$option_ignore_arch_flag{$ignore_arch}}, $ignore_flag;
547 # Precompile all flag regexps. any_flags_used(), all_flags_used() get a lot
549 foreach my $flags (@flag_refs_all) {
550 @{$flags} = compile_flag_regexp(\%flag_renames, @{$flags});
553 # Precompile ignore line regexps, also anchor at beginning and end of line.
554 foreach my $ignore (@option_ignore_line) {
555 $ignore = qr/^$ignore$/;
557 # Same for arch specific ignore lines.
558 if (scalar @option_ignore_arch_line > 0) {
559 foreach my $ignore (@option_ignore_arch_line) {
560 my ($ignore_arch, $ignore_line) = split ':', $ignore, 2;
562 if (not $ignore_arch or not $ignore_line) {
563 printf STDERR 'Value "%s" invalid for option ignore-arch-line '
564 . '("arch:line" expected)' . "\n", $ignore;
566 Pod::Usage::pod2usage(2);
569 push @{$option_ignore_arch_line{$ignore_arch}}, qr/^$ignore_line$/;
577 foreach my $file (@ARGV) {
578 print "checking '$file'...\n" if scalar @ARGV > 1;
580 open my $fh, '<', $file or die $!;
582 # Architecture of this file.
583 my $arch = $option_arch;
585 # Hardening options. Not all architectures support all hardening options.
586 my $harden_format = 1;
587 my $harden_fortify = 1;
588 my $harden_stack = 1;
589 my $harden_relro = 1;
590 my $harden_bindnow = $option_bindnow; # defaults to 0
591 my $harden_pie = $option_pie; # defaults to 0
593 while (my $line = <$fh>) {
594 # Detect architecture automatically unless overridden. For buildd logs
595 # only, doesn't use the dpkg-buildpackage header. Necessary to ignore
596 # build logs which aren't built (wrong architecture, build error,
599 and $line =~ /^Architecture: (.+)$/) {
603 # dpkg-buildflags only provides hardening flags since 1.16.1, don't
604 # check for hardening flags in buildd mode if an older dpkg-dev is
605 # used. Default flags (-g -O2) are still checked.
607 # Packages which were built before 1.16.1 but used their own hardening
608 # flags are not checked.
610 and index($line, 'Toolchain package versions: ') == 0) {
611 require Dpkg::Version;
612 if (not $line =~ /\bdpkg-dev_(\S+)/
613 or Dpkg::Version::version_compare($1, '1.16.1') < 0) {
623 # The following two versions of CMake in Debian obeyed CPPFLAGS, but
624 # this was later dropped because upstream rejected the patch. Thus
625 # build logs with these versions will have fortify hardening flags
626 # enabled, even though they may be not correctly set and are missing
627 # when build with later CMake versions. Thanks to Aron Xu for letting
629 if (index($line, 'Package versions: ') == 0
630 and $line =~ /\bcmake_(\S+)/
631 and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
632 if (not $option_buildd) {
633 error_invalid_cmake($1);
635 print "$buildd_tag{invalid_cmake} $1\n";
637 $exit |= $exit_code{invalid_cmake};
640 # If hardening wrapper is used (wraps calls to gcc and adds hardening
641 # flags automatically) we can't perform any checks, abort.
642 if (index($line, 'Build-Depends: ') == 0
643 and $line =~ /\bhardening-wrapper\b/) {
644 if (not $option_buildd) {
645 error_hardening_wrapper();
647 print "$buildd_tag{hardening_wrapper}\n";
649 $exit |= $exit_code{hardening_wrapper};
653 # We skip over unimportant lines at the beginning of the log to
654 # prevent false positives.
655 last if index($line, 'dpkg-buildpackage: ') == 0;
658 # Input lines, contain only the lines with compiler commands.
661 my $continuation = 0;
662 my $complete_line = undef;
663 while (my $line = <$fh>) {
664 # And stop at the end of the build log. Package details (reported by
665 # the buildd logs) are not important for us. This also prevents false
667 last if $line =~ /^Build finished at \d{8}-\d{4}$/;
669 # Detect architecture automatically unless overridden.
671 and $line =~ /^dpkg-buildpackage: host architecture (.+)$/) {
675 # Ignore compiler warnings for now.
676 next if $line =~ /$warning_regex/o;
678 if (not $option_buildd and index($line, "\033") != -1) { # esc
679 # Remove all ANSI color sequences which are sometimes used in
680 # non-verbose builds.
681 $line = Term::ANSIColor::colorstrip($line);
682 # Also strip '\0xf' (delete previous character), used by Elinks'
685 # And "ESC(B" which seems to be used on armhf and hurd (not sure
687 $line =~ s/\033\(B//g;
690 # Check if this line indicates a non verbose build.
691 my $non_verbose = is_non_verbose_build($line);
693 # One line may contain multiple commands (";"). Treat each one as
694 # single line. parse_line() is slow, only use it when necessary.
695 my @line = (index($line, ';') == -1)
698 # Ensure newline at the line end - necessary for
699 # correct parsing later.
702 } Text::ParseWords::parse_line(';', 1, $line);
703 foreach my $line (@line) {
707 # Join lines, but leave the "\" in place so it's clear where
708 # the original line break was.
709 chomp $complete_line;
710 $complete_line .= ' ' . $line;
712 # Line continuation, line ends with "\".
713 if ($line =~ /\\$/) {
715 # Start line continuation.
716 if (not defined $complete_line) {
717 $complete_line = $line;
722 # Use the complete line if a line continuation occurred.
723 if (defined $complete_line) {
724 $line = $complete_line;
725 $complete_line = undef;
728 # Ignore lines with no compiler commands.
729 next if not $non_verbose
730 and not $line =~ /\b$cc_regex(?:\s|\\)/o;
731 # Ignore lines with no filenames with extensions. May miss some
732 # non-verbose builds (e.g. "gcc -o test" [sic!]), but shouldn't be
733 # a problem as the log will most likely contain other non-verbose
734 # commands which are detected.
735 next if not $non_verbose
736 and not $line =~ /$file_extension_regex/o;
738 # Ignore false positives.
740 # `./configure` output.
741 next if not $non_verbose
742 and $line =~ /^(?:checking|[Cc]onfigure:) /;
743 next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
744 [Cc]ompiler[\s.]*:?\s+
746 next if $line =~ /^\s*(?:- )?(?:HOST_)?(?:CC|CXX)\s*=\s*$cc_regex_full\s*$/o;
748 # Check if additional hardening options were used. Used to ensure
749 # they are used for the complete build.
750 $harden_pie = 1 if any_flags_used($line, @def_cflags_pie, @def_ldflags_pie);
751 $harden_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
759 # Ignore arch if requested.
760 if (scalar @option_ignore_arch > 0 and $arch) {
761 foreach my $ignore (@option_ignore_arch) {
762 if ($arch eq $ignore) {
763 print "ignoring architecture '$arch'\n";
769 if (scalar @input == 0) {
770 if (not $option_buildd) {
771 print "No compiler commands!\n";
773 print "$buildd_tag{no_compiler_commands}\n";
775 $exit |= $exit_code{no_compiler_commands};
779 if ($option_buildd) {
780 $statistics{commands} += scalar @input;
783 # Option or auto detected.
785 # The following was partially copied from dpkg-dev 1.16.1.2
786 # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, add_hardening_flags()),
787 # copyright Raphaël Hertzog <hertzog@debian.org>, Kees Cook
788 # <kees@debian.org>, Canonical, Ltd. licensed under GPL version 2 or
789 # later. Keep it in sync.
792 my ($abi, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
794 # Disable unsupported hardening options.
795 if ($cpu =~ /^(?:ia64|alpha|mips|mipsel|hppa)$/ or $arch eq 'arm') {
798 if ($cpu =~ /^(?:ia64|hppa|avr32)$/) {
805 my @cflags = @def_cflags;
806 my @cxxflags = @def_cxxflags;
807 my @cppflags = @def_cppflags;
808 my @ldflags = @def_ldflags;
809 # Check the specified hardening options, same order as dpkg-buildflags.
811 @cflags = (@cflags, @def_cflags_pie);
812 @cxxflags = (@cxxflags, @def_cflags_pie);
813 @ldflags = (@ldflags, @def_ldflags_pie);
816 @cflags = (@cflags, @def_cflags_stack);
817 @cxxflags = (@cxxflags, @def_cflags_stack);
819 if ($harden_fortify) {
820 @cflags = (@cflags, @def_cflags_fortify);
821 @cxxflags = (@cxxflags, @def_cflags_fortify);
822 @cppflags = (@cppflags, @def_cppflags_fortify);
824 if ($harden_format) {
825 @cflags = (@cflags, @def_cflags_format);
826 @cxxflags = (@cxxflags, @def_cflags_format);
829 @ldflags = (@ldflags, @def_ldflags_relro);
831 if ($harden_bindnow) {
832 @ldflags = (@ldflags, @def_ldflags_bindnow);
835 # Ignore flags for this arch if requested.
836 if ($arch and exists $option_ignore_arch_flag{$arch}) {
837 my @flag_refs = (\@cflags, \@cxxflags, \@cppflags, \@ldflags);
839 remove_flags(\@flag_refs,
841 @{$option_ignore_arch_flag{$arch}});
844 my @ignore_line = @option_ignore_line;
845 # Ignore lines for this arch if requested.
846 if ($arch and exists $option_ignore_arch_line{$arch}) {
847 @ignore_line = (@ignore_line, @{$option_ignore_arch_line{$arch}});
851 for (my $i = 0; $i < scalar @input; $i++) {
852 my $line = $input[$i];
854 # Ignore line if requested.
855 foreach my $ignore (@ignore_line) {
856 next LINE if $line =~ /$ignore/;
860 if (is_non_verbose_build($line, $input[$i + 1], \$skip)) {
861 if (not $option_buildd) {
862 error_non_verbose_build($line);
864 $statistics{commands_nonverbose}++;
866 $exit |= $exit_code{non_verbose_build};
869 # Even if it's a verbose build, we might have to skip this line.
872 # Remove everything until and including the compiler command. Makes
873 # checks easier and faster.
874 $line =~ s/^.*?$cc_regex//o;
875 # "([...] test.c)" is not detected as 'test.c' - fix this by removing
876 # the brace and similar characters.
877 $line =~ s/['")]+$//;
879 # Skip unnecessary tests when only preprocessing.
880 my $flag_preprocess = 0;
887 # Preprocess, compile, assemble.
888 if ($line =~ /\s(-E|-S|-c)\b/) {
890 $flag_preprocess = 1 if $1 eq '-E';
891 $compile = 1 if $1 eq '-S' or $1 eq '-c';
892 # Dependency generation for Makefiles. The other flags (-MF -MG -MP
893 # -MT -MQ) are always used with -M/-MM.
894 } elsif ($line =~ /\s(?:-M|-MM)\b/) {
896 # Otherwise assume we are linking.
901 # -MD/-MMD also cause dependency generation, but they don't imply -E!
902 if ($line =~ /\s(?:-MD|-MMD)\b/) {
904 $flag_preprocess = 0;
907 # Dependency generation for Makefiles, no preprocessing or other flags
911 # Get all file extensions on this line.
912 my @extensions = $line =~ /$file_extension_regex/go;
913 # Ignore all unknown extensions to speedup the search below.
914 @extensions = grep { exists $extension{$_} } @extensions;
916 # These file types don't require preprocessing.
917 if (extension_found(\%extensions_no_preprocess, @extensions)) {
920 # These file types require preprocessing.
921 if (extension_found(\%extensions_preprocess, @extensions)) {
925 # If there are source files then it's compiling/linking in one step
926 # and we must check both. We only check for source files here, because
927 # header files cause too many false positives.
928 if (not $flag_preprocess
929 and extension_found(\%extensions_compile_link, @extensions)) {
930 # Assembly files don't need CFLAGS.
931 if (not extension_found(\%extensions_compile, @extensions)
932 and extension_found(\%extensions_no_compile, @extensions)) {
940 # Assume CXXFLAGS are required when a C++ file is specified in the
944 and extension_found(\%extensions_compile_cpp, @extensions)) {
949 if ($option_buildd) {
950 $statistics{preprocess}++ if $preprocess;
951 $statistics{compile}++ if $compile;
952 $statistics{compile_cpp}++ if $compile_cpp;
953 $statistics{link}++ if $link;
956 # Check hardening flags.
958 if ($compile and not all_flags_used($line, \@missing, @cflags)
959 # Libraries linked with -fPIC don't have to (and can't) be
960 # linked with -fPIE as well. It's no error if only PIE flags
962 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
963 # Assume dpkg-buildflags returns the correct flags.
964 and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
965 if (not $option_buildd) {
966 error_flags('CFLAGS missing', \@missing, \%flag_renames, $input[$i]);
968 $statistics{compile_missing}++;
970 $exit |= $exit_code{flags_missing};
971 } elsif ($compile_cpp and not all_flags_used($line, \@missing, @cflags)
972 # Libraries linked with -fPIC don't have to (and can't) be
973 # linked with -fPIE as well. It's no error if only PIE flags
975 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
976 # Assume dpkg-buildflags returns the correct flags.
977 and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
978 if (not $option_buildd) {
979 error_flags('CXXFLAGS missing', \@missing, \%flag_renames, $input[$i]);
981 $statistics{compile_cpp_missing}++;
983 $exit |= $exit_code{flags_missing};
985 if ($preprocess and not all_flags_used($line, \@missing, @cppflags)
986 # Assume dpkg-buildflags returns the correct flags.
987 and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
988 if (not $option_buildd) {
989 error_flags('CPPFLAGS missing', \@missing, \%flag_renames, $input[$i]);
991 $statistics{preprocess_missing}++;
993 $exit |= $exit_code{flags_missing};
995 if ($link and not all_flags_used($line, \@missing, @ldflags)
996 # Same here, -fPIC conflicts with -fPIE.
997 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie)
998 # Assume dpkg-buildflags returns the correct flags.
999 and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
1000 if (not $option_buildd) {
1001 error_flags('LDFLAGS missing', \@missing, \%flag_renames, $input[$i]);
1003 $statistics{link_missing}++;
1005 $exit |= $exit_code{flags_missing};
1010 # Print statistics for buildd mode, only output in this mode.
1011 if ($option_buildd) {
1014 if ($statistics{preprocess_missing}) {
1015 push @warning, sprintf 'CPPFLAGS %d (of %d)',
1016 $statistics{preprocess_missing},
1017 $statistics{preprocess};
1019 if ($statistics{compile_missing}) {
1020 push @warning, sprintf 'CFLAGS %d (of %d)',
1021 $statistics{compile_missing},
1022 $statistics{compile};
1024 if ($statistics{compile_cpp_missing}) {
1025 push @warning, sprintf 'CXXFLAGS %d (of %d)',
1026 $statistics{compile_cpp_missing},
1027 $statistics{compile_cpp};
1029 if ($statistics{link_missing}) {
1030 push @warning, sprintf 'LDFLAGS %d (of %d)',
1031 $statistics{link_missing},
1034 if (scalar @warning) {
1035 local $" = ', '; # array join string
1036 print "$buildd_tag{flags_missing} @warning missing\n";
1039 if ($statistics{commands_nonverbose}) {
1040 printf "$buildd_tag{non_verbose_build} %d (of %d) hidden\n",
1041 $statistics{commands_nonverbose},
1042 $statistics{commands},
1054 blhc - build log hardening check, checks build logs for missing hardening flags
1058 B<blhc> [I<options>] I<E<lt>dpkg-buildpackage build log fileE<gt>..>
1062 blhc is a small tool which checks build logs for missing hardening flags. It's
1063 licensed under the GPL 3 or later.
1065 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
1066 tools using dpkg-buildpackage like pbuilder or the official buildd build logs)
1067 to help maintainers detect missing hardening flags in their packages.
1075 Force check for all +all (+pie, +bindnow) hardening flags. By default it's
1078 =item B<--arch> I<architecture>
1080 Set the specific architecture (e.g. amd64, armel, etc.), automatically
1081 disables hardening flags not available on this architecture. Is detected
1082 automatically if dpkg-buildpackage is used.
1086 Force check for all +bindnow hardening flags. By default it's auto detected.
1090 Special mode for buildds when automatically parsing log files. The following
1091 changes are in effect:
1097 Print tags instead of normal warnings, see L</"BUILDD TAGS"> for a list of
1102 Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is
1107 Don't require Term::ANSIColor.
1113 Use colored (ANSI) output for warning messages.
1115 =item B<--ignore-arch> I<arch>
1117 Ignore build logs from architectures matching I<arch>. I<arch> is a string.
1119 Used to prevent false positives. This option can be specified multiple times.
1121 =item B<--ignore-arch-flag> I<arch>:I<flag>
1123 Like B<--ignore-flag>, but only ignore flag on I<arch>.
1125 =item B<--ignore-arch-line> I<arch>:I<line>
1127 Like B<--ignore-line>, but only ignore line on I<arch>.
1129 =item B<--ignore-flag> I<flag>
1131 Don't print an error when the specific flag is missing in a compiler line.
1132 I<flag> is a string.
1134 Used to prevent false positives. This option can be specified multiple times.
1136 =item B<--ignore-line> I<regex>
1138 Ignore lines matching the given Perl regex. I<regex> is automatically anchored
1139 at the beginning and end of the line to prevent false negatives.
1141 B<NOTE>: Not the input lines are checked, but the lines which are displayed in
1142 warnings (which have line continuation resolved).
1144 Used to prevent false positives. This option can be specified multiple times.
1148 Force check for all +pie hardening flags. By default it's auto detected.
1150 =item B<-h -? --help>
1152 Print available options.
1156 Print version number and license.
1160 Auto detection for B<--pie> and B<--bindnow> only works if at least one
1161 command uses the required hardening flag (e.g. -fPIE). Then it's required for
1162 all other commands as well.
1166 Normal usage, parse a single log file.
1168 blhc path/to/log/file
1170 Parse multiple log files. The exit code is ORed over all files.
1172 blhc path/to/directory/with/log/files/*
1174 Don't treat missing C<-g> as error:
1176 blhc --ignore-flag -g path/to/log/file
1178 Don't treat missing C<-pie> on kfreebsd-amd64 as error:
1180 blhc --ignore-arch-flag kfreebsd-amd64:-pie path/to/log/file
1182 Ignore lines consisting exactly of C<./script gcc file> which would cause a
1185 blhc --ignore-line '\./script gcc file' path/to/log/file
1187 Ignore lines matching C<./script gcc file> somewhere in the line.
1189 blhc --ignore-line '.*\./script gcc file.*' path/to/log/file
1191 Use blhc with pbuilder.
1193 pbuilder path/to/package.dsc | tee path/log/file
1194 blhc path/to/file || echo flags missing
1198 The following tags are used in I<--buildd> mode. In braces the additional data
1203 =item B<I-hardening-wrapper-used>
1205 The package uses hardening-wrapper which intercepts calls to gcc and adds
1206 hardening flags. The build log doesn't contain any hardening flags and thus
1207 can't be checked by blhc.
1209 =item B<W-compiler-flags-hidden> (summary of hidden lines)
1211 Build log contains lines which hide the real compiler flags. For example:
1218 Most of the time either C<export V=1> or C<export verbose=1> in
1219 F<debian/rules> fixes builds with hidden compiler flags. Sometimes C<.SILENT>
1220 in a F<Makefile> must be removed. And as last resort the F<Makefile> must be
1221 patched to remove the C<@>s hiding the real compiler commands.
1223 =item B<W-dpkg-buildflags-missing> (summary of missing flags)
1225 CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
1227 =item B<I-invalid-cmake-used> (version)
1229 By default CMake ignores CPPFLAGS thus missing those hardening flags. Debian
1230 patched CMake in versions 2.8.7-1 and 2.8.7-2 to respect CPPFLAGS, but this
1231 patch was rejected by upstream and later reverted in Debian. Thus those two
1232 versions show correct usage of CPPFLAGS even if the package doesn't correctly
1233 handle them (for example by passing them to CFLAGS). To prevent false
1234 negatives just blacklist those two versions.
1236 =item B<I-no-compiler-commands>
1238 No compiler commands were detected. Either the log contains none or they were
1239 not correctly detected by blhc (please report the bug in this case).
1245 The exit status is a "bit mask", each listed status is ORed when the error
1246 condition occurs to get the result.
1256 No compiler commands were found.
1260 Invalid arguments/options given to blhc.
1268 Missing hardening flags.
1272 Hardening wrapper detected, no tests performed.
1276 Invalid CMake version used. See B<I-invalid-cmake-used> under L</"BUILDD
1277 TAGS"> for a detailed explanation.
1283 Simon Ruderich, E<lt>simon@ruderich.orgE<gt>
1285 Thanks to to Bernhard R. Link E<lt>brlink@debian.orgE<gt> and Jaria Alto
1286 E<lt>jari.aalto@cante.netE<gt> for their valuable input and suggestions.
1288 =head1 COPYRIGHT AND LICENSE
1290 Copyright (C) 2012 by Simon Ruderich
1292 This program is free software: you can redistribute it and/or modify
1293 it under the terms of the GNU General Public License as published by
1294 the Free Software Foundation, either version 3 of the License, or
1295 (at your option) any later version.
1297 This program is distributed in the hope that it will be useful,
1298 but WITHOUT ANY WARRANTY; without even the implied warranty of
1299 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1300 GNU General Public License for more details.
1302 You should have received a copy of the GNU General Public License
1303 along with this program. If not, see <http://www.gnu.org/licenses/>.
1307 L<hardening-check(1)>, L<dpkg-buildflags(1)>