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.01';
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/^(.+?):([0-9]+):[0-9]+: 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 = (
157 '-Werror=format-security',
159 my @def_cflags_fortify = (
160 # fortify needs at least -O1, but -O2 is recommended anyway
162 my @def_cflags_stack = (
164 '--param=ssp-buffer-size=4',
166 my @def_cflags_pie = (
172 # @def_cxxflags_* is the same as @def_cflags_*.
173 my @def_cppflags = ();
174 my @def_cppflags_fortify = (
175 '-D_FORTIFY_SOURCE=2',
177 my @def_ldflags = ();
178 my @def_ldflags_relro = (
181 my @def_ldflags_bindnow = (
184 my @def_ldflags_pie = (
188 my @def_ldflags_pic = (
193 # References to all flags checked by the parser.
197 \@def_cflags_fortify,
202 \@def_cppflags_fortify,
205 \@def_ldflags_bindnow,
207 # References to all used flags.
208 my @flag_refs_all = (
213 # Renaming rules for the output so the regex parts are not visible. Also
214 # stores string values of flag regexps above, see compile_flag_regexp().
216 '-O(?:2|3)' => '-O2',
217 '-Wl,(?:-z,)?relro' => '-Wl,-z,relro',
218 '-Wl,(?:-z,)?now' => '-Wl,-z,now',
222 no_compiler_commands => 1 << 0,
223 # used by POD::Usage => 1 << 1,
224 non_verbose_build => 1 << 2,
225 flags_missing => 1 << 3,
226 hardening_wrapper => 1 << 4,
227 invalid_cmake => 1 << 5,
230 # Statistics of missing flags and non-verbose build commands. Used for
234 preprocess_missing => 0,
236 compile_missing => 0,
238 compile_cpp_missing => 0,
242 commands_nonverbose => 0,
245 # Use colored (ANSI) output?
252 my ($message, $missing_flags_ref, $flag_renames_ref, $line) = @_;
254 # Get string value of qr//-escaped regexps and if requested rename them.
255 my @missing_flags = map {
256 $flag_renames_ref->{$_}
257 } @{$missing_flags_ref};
259 my $flags = join ' ', @missing_flags;
260 printf "%s (%s)%s %s",
261 error_color($message, 'red'), $flags, error_color(':', 'yellow'),
264 sub error_non_verbose_build {
268 error_color('NONVERBOSE BUILD', 'red'),
269 error_color(':', 'yellow'),
272 sub error_invalid_cmake {
276 error_color('INVALID CMAKE', 'red'),
277 error_color(':', 'yellow'),
280 sub error_hardening_wrapper {
282 error_color('HARDENING WRAPPER', 'red'),
283 error_color(':', 'yellow'),
284 'no checks possible, aborting';
287 my ($message, $color) = @_;
290 return Term::ANSIColor::colored($message, $color);
297 my ($line, @flags) = @_;
299 foreach my $flag (@flags) {
300 return 1 if $line =~ /$flag/;
306 my ($line, $missing_flags_ref, @flags) = @_;
308 my @missing_flags = ();
309 foreach my $flag (@flags) {
310 if (not $line =~ /$flag/) {
311 push @missing_flags, $flag;
315 return 1 if scalar @missing_flags == 0;
317 @{$missing_flags_ref} = @missing_flags;
321 # Modifies $missing_flags_ref array.
322 sub pic_pie_conflict {
323 my ($line, $pie, $missing_flags_ref, @flags_pie) = @_;
325 return 0 if not $pie;
326 return 0 if not any_flags_used($line, @def_ldflags_pic);
328 my %flags = map { $_ => 1 } @flags_pie;
330 # Remove all PIE flags from @missing_flags as they are not required with
333 not exists $flags{$_}
334 } @{$missing_flags_ref};
335 @{$missing_flags_ref} = @result;
337 # We got a conflict when no flags are left, thus only PIE flags were
338 # missing. If other flags were missing abort because the conflict is not
340 return scalar @result == 0;
343 sub is_non_verbose_build {
344 my ($line, $next_line, $skip_ref) = @_;
346 if (not (index($line, 'checking if you want to see long compiling messages... no') == 0
347 or $line =~ /^\s*\[?(?:CC|CCLD|C\+\+|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/
348 or $line =~ /^\s*(?:C|c)ompiling\s+(.+?)(?:\.\.\.)?$/
349 or $line =~ /^\s*(?:B|b)uilding (?:program|shared library)\s+(.+?)$/
350 or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
356 # C++ compiler setting.
357 return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
358 # "Compiling" with no file name.
359 if ($line =~ /^\s*(?:C|c)ompiling\s+(.+?)(?:\.\.\.)?$/) {
360 # $file_extension_regex may need spaces around the filename.
361 return 0 if not " $1 " =~ /$file_extension_regex/o;
366 # On the first pass we only check if this line is verbose or not.
367 return 1 if not defined $next_line;
369 # Second pass, we have access to the next line.
372 # CMake and other build systems print the non-verbose messages also when
373 # building verbose. If a compiler and the file name occurs in the next
374 # line, treat it as verbose build.
376 # Get filename, we can't use the complete path as only parts of it are
377 # used in the real compiler command.
378 $file =~ m{/([^/\s]+)$};
381 if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
382 # We still have to skip the current line as it doesn't contain any
392 sub compile_flag_regexp {
393 my ($flag_renames_ref, @flags) = @_;
396 foreach my $flag (@flags) {
397 # Store flag name in replacement string for correct flags in messages
398 # with qr//ed flag regexps.
399 $flag_renames_ref->{qr/\s$flag(?:\s|\\)/}
400 = (exists $flag_renames_ref->{$flag})
401 ? $flag_renames_ref->{$flag}
404 # Compile flag regexp for faster execution.
405 push @result, qr/\s$flag(?:\s|\\)/;
410 sub extension_found {
411 my ($extensions_ref, @extensions) = @_;
414 foreach my $extension (@extensions) {
415 if (exists $extensions_ref->{$extension}) {
426 # Parse command line arguments.
428 my $option_version = 0;
430 my $option_bindnow = 0;
431 my @option_ignore_arch = ();
432 my @option_ignore_flag = ();
433 my @option_ignore_line = ();
435 my $option_arch = undef;
436 my $option_buildd = 0;
438 if (not Getopt::Long::GetOptions(
439 'help|h|?' => \$option_help,
440 'version' => \$option_version,
442 'pie' => \$option_pie,
443 'bindnow' => \$option_bindnow,
444 'all' => \$option_all,
446 'ignore-arch=s' => \@option_ignore_arch,
447 'ignore-flag=s' => \@option_ignore_flag,
448 'ignore-line=s' => \@option_ignore_line,
450 'color' => \$option_color,
451 'arch=s' => \$option_arch,
452 'buildd' => \$option_buildd,
454 or scalar @ARGV == 0) {
456 Pod::Usage::pod2usage(2);
460 Pod::Usage::pod2usage(1);
462 if ($option_version) {
463 print "blhc $VERSION Copyright (C) 2012 Simon Ruderich
465 This program is free software: you can redistribute it and/or modify
466 it under the terms of the GNU General Public License as published by
467 the Free Software Foundation, either version 3 of the License, or
468 (at your option) any later version.
470 This program is distributed in the hope that it will be useful,
471 but WITHOUT ANY WARRANTY; without even the implied warranty of
472 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
473 GNU General Public License for more details.
475 You should have received a copy of the GNU General Public License
476 along with this program. If not, see <http://www.gnu.org/licenses/>.
481 # Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not
482 # installed on Debian's buildds.
483 if (not $option_buildd) {
484 require Term::ANSIColor;
492 # Strip flags which should be ignored.
493 if (scalar @option_ignore_flag > 0) {
494 my %ignores = map { $_ => 1 } @option_ignore_flag;
495 foreach my $flags (@flag_refs) {
497 # Flag found as string.
498 not exists $ignores{$_}
499 # Flag found as string representation of regexp.
500 and (not defined $flag_renames{$_}
501 or not exists $ignores{$flag_renames{$_}})
506 # Precompile all flag regexps. any_flags_used(), all_flags_used() get a lot
508 foreach my $flags (@flag_refs_all) {
509 @{$flags} = compile_flag_regexp(\%flag_renames, @{$flags});
512 # Precompile ignore line regexps, also anchor at beginning and end of line.
513 foreach my $ignore (@option_ignore_line) {
514 $ignore = qr/^$ignore$/;
521 foreach my $file (@ARGV) {
522 print "checking '$file'...\n" if scalar @ARGV > 1;
524 open my $fh, '<', $file or die "$!: $file";
526 # Architecture of this file.
527 my $arch = $option_arch;
529 # Hardening options. Not all architectures support all hardening options.
530 my $harden_format = 1;
531 my $harden_fortify = 1;
532 my $harden_stack = 1;
533 my $harden_relro = 1;
534 my $harden_bindnow = $option_bindnow; # defaults to 0
535 my $harden_pie = $option_pie; # defaults to 0
537 while (my $line = <$fh>) {
538 # dpkg-buildflags only provides hardening flags since 1.16.1, don't
539 # check for hardening flags in buildd mode if an older dpkg-dev is
540 # used. Default flags (-g -O2) are still checked.
542 # Packages which were built before 1.16.1 but used their own hardening
543 # flags are not checked.
545 and index($line, 'Toolchain package versions: ') == 0) {
546 require Dpkg::Version;
547 if (not $line =~ /\bdpkg-dev_(\S+)/
548 or Dpkg::Version::version_compare($1, '1.16.1') < 0) {
558 # The following two versions of CMake in Debian obeyed CPPFLAGS, but
559 # this was later dropped because upstream rejected the patch. Thus
560 # build logs with these versions will have fortify hardening flags
561 # enabled, even though they may be not correctly set and are missing
562 # when build with later CMake versions. Thanks to Aron Xu for letting
564 if (index($line, 'Package versions: ') == 0
565 and $line =~ /\bcmake_(\S+)/
566 and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
567 if (not $option_buildd) {
568 error_invalid_cmake($1);
570 print "W-invalid-cmake-used $1\n";
572 $exit |= $exit_code{invalid_cmake};
575 # If hardening wrapper is used (wraps calls to gcc and adds hardening
576 # flags automatically) we can't perform any checks, abort.
577 if (index($line, 'Build-Depends: ') == 0
578 and $line =~ /\bhardening-wrapper\b/) {
579 if (not $option_buildd) {
580 error_hardening_wrapper();
582 print "I-hardening-wrapper-used\n";
584 $exit |= $exit_code{hardening_wrapper};
588 # We skip over unimportant lines at the beginning of the log to
589 # prevent false positives.
590 last if index($line, 'dpkg-buildpackage: ') == 0;
593 # Input lines, contain only the lines with compiler commands.
596 my $continuation = 0;
597 my $complete_line = undef;
598 while (my $line = <$fh>) {
599 # And stop at the end of the build log. Package details (reported by
600 # the buildd logs) are not important for us. This also prevents false
602 last if $line =~ /^Build finished at \d{8}-\d{4}$/;
604 # Detect architecture automatically unless overridden.
606 and $line =~ /^dpkg-buildpackage: host architecture (.+)$/) {
610 # Ignore compiler warnings for now.
611 next if $line =~ /$warning_regex/o;
613 if (not $option_buildd and index($line, "\033") != -1) { # esc
614 # Remove all ANSI color sequences which are sometimes used in
615 # non-verbose builds.
616 $line = Term::ANSIColor::colorstrip($line);
617 # Also strip '\0xf' (delete previous character), used by Elinks'
620 # And "ESC(B" which seems to be used on armhf and hurd (not sure
622 $line =~ s/\033\(B//g;
625 # Check if this line indicates a non verbose build.
626 my $non_verbose = is_non_verbose_build($line);
628 # One line may contain multiple commands (";"). Treat each one as
629 # single line. parse_line() is slow, only use it when necessary.
630 my @line = (index($line, ';') == -1)
633 # Ensure newline at the line end - necessary for
634 # correct parsing later.
637 } Text::ParseWords::parse_line(';', 1, $line);
638 foreach $line (@line) {
642 # Join lines, but leave the "\" in place so it's clear where
643 # the original line break was.
644 chomp $complete_line;
645 $complete_line .= ' ' . $line;
647 # Line continuation, line ends with "\".
648 if ($line =~ /\\$/) {
650 # Start line continuation.
651 if (not defined $complete_line) {
652 $complete_line = $line;
657 # Use the complete line if a line continuation occurred.
658 if (defined $complete_line) {
659 $line = $complete_line;
660 $complete_line = undef;
663 # Ignore lines with no compiler commands.
664 next if not $non_verbose
665 and not $line =~ /\b$cc_regex(?:\s|\\)/o;
666 # Ignore lines with no filenames with extensions. May miss some
667 # non-verbose builds (e.g. "gcc -o test" [sic!]), but shouldn't be
668 # a problem as the log will most likely contain other non-verbose
669 # commands which are detected.
670 next if not $non_verbose
671 and not $line =~ /$file_extension_regex/o;
673 # Ignore false positives.
675 # `./configure` output.
676 next if not $non_verbose
677 and $line =~ /^(?:checking|(?:C|c)onfigure:) /;
678 next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
679 (?:C|c)ompiler[\s.]*:?\s+
681 next if $line =~ /^\s*(?:- )?(?:HOST_)?(?:CC|CXX)\s*=\s*$cc_regex_full\s*$/o;
683 # Check if additional hardening options were used. Used to ensure
684 # they are used for the complete build.
685 $harden_pie = 1 if any_flags_used($line, @def_cflags_pie, @def_ldflags_pie);
686 $harden_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
694 # Ignore arch if requested.
695 if (scalar @option_ignore_arch > 0 and $arch) {
696 foreach my $ignore (@option_ignore_arch) {
697 if ($arch eq $ignore) {
698 print "ignoring architecture '$arch'\n";
704 if (scalar @input == 0) {
705 if (not $option_buildd) {
706 print "No compiler commands!\n";
708 print "W-no-compiler-commands\n";
710 $exit |= $exit_code{no_compiler_commands};
714 if ($option_buildd) {
715 $statistics{commands} += scalar @input;
718 # Option or auto detected.
720 # The following was partially copied from dpkg-dev 1.16.1.2
721 # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, add_hardening_flags()),
722 # copyright Raphaël Hertzog <hertzog@debian.org>, Kees Cook
723 # <kees@debian.org>, Canonical, Ltd. licensed under GPL version 2 or
724 # later. Keep it in sync.
727 my ($abi, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
729 # Disable unsupported hardening options.
730 if ($cpu =~ /^(?:ia64|alpha|mips|mipsel|hppa)$/ or $arch eq 'arm') {
733 if ($cpu =~ /^(?:ia64|hppa|avr32)$/) {
740 my @cflags = @def_cflags;
741 my @cxxflags = @def_cxxflags;
742 my @cppflags = @def_cppflags;
743 my @ldflags = @def_ldflags;
744 # Check the specified hardening options, same order as dpkg-buildflags.
746 @cflags = (@cflags, @def_cflags_pie);
747 @cxxflags = (@cxxflags, @def_cflags_pie);
748 @ldflags = (@ldflags, @def_ldflags_pie);
751 @cflags = (@cflags, @def_cflags_stack);
752 @cxxflags = (@cxxflags, @def_cflags_stack);
754 if ($harden_fortify) {
755 @cflags = (@cflags, @def_cflags_fortify);
756 @cxxflags = (@cxxflags, @def_cflags_fortify);
757 @cppflags = (@cppflags, @def_cppflags_fortify);
759 if ($harden_format) {
760 @cflags = (@cflags, @def_cflags_format);
761 @cxxflags = (@cxxflags, @def_cflags_format);
764 @ldflags = (@ldflags, @def_ldflags_relro);
766 if ($harden_bindnow) {
767 @ldflags = (@ldflags, @def_ldflags_bindnow);
771 for (my $i = 0; $i < scalar @input; $i++) {
772 my $line = $input[$i];
774 # Ignore line if requested.
775 foreach my $ignore (@option_ignore_line) {
776 next LINE if $line =~ /$ignore/;
780 if (is_non_verbose_build($line, $input[$i + 1], \$skip)) {
781 if (not $option_buildd) {
782 error_non_verbose_build($line);
784 $statistics{commands_nonverbose}++;
786 $exit |= $exit_code{non_verbose_build};
789 # Even if it's a verbose build, we might have to skip this line.
792 # Remove everything until and including the compiler command. Makes
793 # checks easier and faster.
794 $line =~ s/^.*?$cc_regex//o;
795 # "([...] test.c)" is not detected as 'test.c' - fix this by removing
796 # the brace and similar characters.
797 $line =~ s/['")]+$//;
799 # Skip unnecessary tests when only preprocessing.
800 my $flag_preprocess = 0;
807 # Preprocess, compile, assemble.
808 if ($line =~ /\s(-E|-S|-c)\b/) {
810 $flag_preprocess = 1 if $1 eq '-E';
811 $compile = 1 if $1 eq '-S' or $1 eq '-c';
812 # Dependency generation for Makefiles. The other flags (-MF -MG -MP
813 # -MT -MQ) are always used with -M/-MM.
814 } elsif ($line =~ /\s(?:-M|-MM)\b/) {
816 # Otherwise assume we are linking.
821 # -MD/-MMD also cause dependency generation, but they don't imply -E!
822 if ($line =~ /\s(?:-MD|-MMD)\b/) {
824 $flag_preprocess = 0;
827 # Dependency generation for Makefiles, no preprocessing or other flags
831 # Get all file extensions on this line.
832 my @extensions = $line =~ /$file_extension_regex/go;
833 # Ignore all unknown extensions to speedup the search below.
834 @extensions = grep { exists $extension{$_} } @extensions;
836 # These file types don't require preprocessing.
837 if (extension_found(\%extensions_no_preprocess, @extensions)) {
840 # These file types require preprocessing.
841 if (extension_found(\%extensions_preprocess, @extensions)) {
845 # If there are source files then it's compiling/linking in one step
846 # and we must check both. We only check for source files here, because
847 # header files cause too many false positives.
848 if (not $flag_preprocess
849 and extension_found(\%extensions_compile_link, @extensions)) {
850 # Assembly files don't need CFLAGS.
851 if (not extension_found(\%extensions_compile, @extensions)
852 and extension_found(\%extensions_no_compile, @extensions)) {
860 # Assume CXXFLAGS are required when a C++ file is specified in the
864 and extension_found(\%extensions_compile_cpp, @extensions)) {
869 if ($option_buildd) {
870 $statistics{preprocess}++ if $preprocess;
871 $statistics{compile}++ if $compile;
872 $statistics{compile_cpp}++ if $compile_cpp;
873 $statistics{link}++ if $link;
876 # Check hardening flags.
878 if ($compile and not all_flags_used($line, \@missing, @cflags)
879 # Libraries linked with -fPIC don't have to (and can't) be
880 # linked with -fPIE as well. It's no error if only PIE flags
882 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
883 # Assume dpkg-buildflags returns the correct flags.
884 and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
885 if (not $option_buildd) {
886 error_flags('CFLAGS missing', \@missing, \%flag_renames, $input[$i]);
888 $statistics{compile_missing}++;
890 $exit |= $exit_code{flags_missing};
891 } elsif ($compile_cpp and not all_flags_used($line, \@missing, @cflags)
892 # Libraries linked with -fPIC don't have to (and can't) be
893 # linked with -fPIE as well. It's no error if only PIE flags
895 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
896 # Assume dpkg-buildflags returns the correct flags.
897 and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
898 if (not $option_buildd) {
899 error_flags('CXXFLAGS missing', \@missing, \%flag_renames, $input[$i]);
901 $statistics{compile_cpp_missing}++;
903 $exit |= $exit_code{flags_missing};
905 if ($preprocess and not all_flags_used($line, \@missing, @cppflags)
906 # Assume dpkg-buildflags returns the correct flags.
907 and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
908 if (not $option_buildd) {
909 error_flags('CPPFLAGS missing', \@missing, \%flag_renames, $input[$i]);
911 $statistics{preprocess_missing}++;
913 $exit |= $exit_code{flags_missing};
915 if ($link and not all_flags_used($line, \@missing, @ldflags)
916 # Same here, -fPIC conflicts with -fPIE.
917 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie)
918 # Assume dpkg-buildflags returns the correct flags.
919 and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
920 if (not $option_buildd) {
921 error_flags('LDFLAGS missing', \@missing, \%flag_renames, $input[$i]);
923 $statistics{link_missing}++;
925 $exit |= $exit_code{flags_missing};
930 # Print statistics for buildd mode, only output in this mode.
931 if ($option_buildd) {
934 if ($statistics{preprocess_missing}) {
935 push @warning, sprintf "CPPFLAGS %d (of %d)",
936 $statistics{preprocess_missing},
937 $statistics{preprocess};
939 if ($statistics{compile_missing}) {
940 push @warning, sprintf "CFLAGS %d (of %d)",
941 $statistics{compile_missing},
942 $statistics{compile};
944 if ($statistics{compile_cpp_missing}) {
945 push @warning, sprintf "CXXFLAGS %d (of %d)",
946 $statistics{compile_cpp_missing},
947 $statistics{compile_cpp};
949 if ($statistics{link_missing}) {
950 push @warning, sprintf "LDFLAGS %d (of %d)",
951 $statistics{link_missing},
954 if (scalar @warning) {
955 local $" = ', '; # array join string
956 print "W-dpkg-buildflags-missing @warning missing\n";
959 if ($statistics{commands_nonverbose}) {
960 printf "W-compiler-flags-hidden %d (of %d) hidden\n",
961 $statistics{commands_nonverbose},
962 $statistics{commands},
974 blhc - build log hardening check, checks build logs for missing hardening flags
978 B<blhc> [I<options>] I<E<lt>dpkg-buildpackage build log fileE<gt>..>
982 blhc is a small tool which checks build logs for missing hardening flags. It's
983 licensed under the GPL 3 or later.
985 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
986 tools using dpkg-buildpackage like pbuilder or the official buildd build logs)
987 to help maintainers detect missing hardening flags in their packages.
995 Force check for all +all (+pie, +bindnow) hardening flags. By default it's
998 =item B<--arch> I<architecture>
1000 Set the specific architecture (e.g. amd64, armel, etc.), automatically
1001 disables hardening flags not available on this architecture. Is detected
1002 automatically if dpkg-buildpackage is used.
1006 Force check for all +bindnow hardening flags. By default it's auto detected.
1010 Special mode for buildds when automatically parsing log files. The following
1011 changes are in effect:
1017 Print tags instead of normal warnings, see L</"BUILDD TAGS"> for a list of
1022 Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is
1027 Don't require Term::ANSIColor.
1033 Use colored (ANSI) output for warning messages.
1035 =item B<--ignore-arch> I<arch>
1037 Ignore build logs from architectures matching I<arch>. I<arch> is a string.
1039 Used to prevent false positives. This option can be specified multiple times.
1041 =item B<--ignore-flag> I<flag>
1043 Don't print an error when the specific flag is missing in a compiler line.
1044 I<flag> is a string.
1046 Used to prevent false positives. This option can be specified multiple times.
1048 =item B<--ignore-line> I<regex>
1050 Ignore lines matching the given Perl regex. I<regex> is automatically anchored
1051 at the beginning and end of the line to prevent false negatives.
1053 B<NOTE>: Not the input lines are checked, but the lines which are displayed in
1054 warnings (which have line continuation resolved).
1056 Used to prevent false positives. This option can be specified multiple times.
1060 Force check for all +pie hardening flags. By default it's auto detected.
1062 =item B<-h -? --help>
1064 Print available options.
1068 Print version number and license.
1072 Auto detection for B<--pie> and B<--bindnow> only works if at least one
1073 command uses the required hardening flag (e.g. -fPIE). Then it's required for
1074 all other commands as well.
1078 Normal usage, parse a single log file.
1080 blhc path/to/log/file
1082 Parse multiple log files. The exit code is ORed over all files.
1084 blhc path/to/directory/with/log/files/*
1086 Don't treat missing C<-g> as error:
1088 blhc --ignore-flag -g path/to/log/file
1090 Ignore lines consisting exactly of C<./script gcc file> which would cause a
1093 blhc --ignore-line '\./script gcc file' path/to/log/file
1095 Ignore lines matching C<./script gcc file> somewhere in the line.
1097 blhc --ignore-line '.*\./script gcc file.*' path/to/log/file
1099 Use blhc with pbuilder.
1101 pbuilder path/to/package.dsc | tee path/log/file
1102 blhc path/to/file || echo flags missing
1106 The following tags are used in I<--buildd> mode. In braces the additional data
1113 B<I-hardening-wrapper-used>
1115 The package uses hardening-wrapper which intercepts calls to gcc and adds
1116 hardening flags. The build log doesn't contain any hardening flags and thus
1117 can't be checked by blhc.
1121 B<W-compiler-flags-hidden> (summary of hidden lines)
1123 Build log contains lines which hide the real compiler flags. For example:
1130 Most of the time either C<export V=1> or C<export verbose=1> in
1131 F<debian/rules> fixes builds with hidden compiler flags. Sometimes C<.SILENT>
1132 in a F<Makefile> must be removed. And as last resort the F<Makefile> must be
1133 patched to remove the C<@>s hiding the real compiler commands.
1137 B<W-dpkg-buildflags-missing> (summary of missing flags)
1139 CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
1143 B<W-invalid-cmake-used> (version)
1147 B<W-no-compiler-commands>
1149 No compiler commands were detected. Either the log contains none or they were
1150 not correctly detected by blhc (please report the bug in this case).
1156 The exit status is a "bit mask", each listed status is ORed when the error
1157 condition occurs to get the result.
1167 No compiler commands were found.
1171 Invalid arguments/options given to blhc.
1179 Missing hardening flags.
1183 Hardening wrapper detected, no tests performed.
1189 Simon Ruderich, E<lt>simon@ruderich.orgE<gt>
1191 Thanks to to Bernhard R. Link E<lt>brlink@debian.orgE<gt> and Jaria Alto
1192 E<lt>jari.aalto@cante.netE<gt> for their valuable input and suggestions.
1194 =head1 COPYRIGHT AND LICENSE
1196 Copyright (C) 2012 by Simon Ruderich
1198 This program is free software: you can redistribute it and/or modify
1199 it under the terms of the GNU General Public License as published by
1200 the Free Software Foundation, either version 3 of the License, or
1201 (at your option) any later version.
1203 This program is distributed in the hope that it will be useful,
1204 but WITHOUT ANY WARRANTY; without even the implied warranty of
1205 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1206 GNU General Public License for more details.
1208 You should have received a copy of the GNU General Public License
1209 along with this program. If not, see <http://www.gnu.org/licenses/>.
1213 L<hardening-check(1)>, L<dpkg-buildflags(1)>