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,
206 # References to all used flags.
207 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,
229 # Statistics of missing flags and non-verbose build commands. Used for
233 preprocess_missing => 0,
235 compile_missing => 0,
237 compile_cpp_missing => 0,
241 commands_nonverbose => 0,
244 # Use colored (ANSI) output?
251 my ($message, $missing_flags_ref, $flag_renames_ref, $line) = @_;
253 # Get string value of qr//-escaped regexps and if requested rename them.
254 my @missing_flags = map {
255 $flag_renames_ref->{$_}
256 } @{$missing_flags_ref};
258 my $flags = join ' ', @missing_flags;
259 printf '%s (%s)%s %s',
260 error_color($message, 'red'), $flags, error_color(':', 'yellow'),
263 sub error_non_verbose_build {
267 error_color('NONVERBOSE BUILD', 'red'),
268 error_color(':', 'yellow'),
271 sub error_invalid_cmake {
275 error_color('INVALID CMAKE', 'red'),
276 error_color(':', 'yellow'),
279 sub error_hardening_wrapper {
281 error_color('HARDENING WRAPPER', 'red'),
282 error_color(':', 'yellow'),
283 'no checks possible, aborting';
286 my ($message, $color) = @_;
289 return Term::ANSIColor::colored($message, $color);
296 my ($line, @flags) = @_;
298 foreach my $flag (@flags) {
299 return 1 if $line =~ /$flag/;
305 my ($line, $missing_flags_ref, @flags) = @_;
307 my @missing_flags = ();
308 foreach my $flag (@flags) {
309 if (not $line =~ /$flag/) {
310 push @missing_flags, $flag;
314 return 1 if scalar @missing_flags == 0;
316 @{$missing_flags_ref} = @missing_flags;
320 # Modifies $missing_flags_ref array.
321 sub pic_pie_conflict {
322 my ($line, $pie, $missing_flags_ref, @flags_pie) = @_;
324 return 0 if not $pie;
325 return 0 if not any_flags_used($line, @def_ldflags_pic);
327 my %flags = map { $_ => 1 } @flags_pie;
329 # Remove all PIE flags from @missing_flags as they are not required with
332 not exists $flags{$_}
333 } @{$missing_flags_ref};
334 @{$missing_flags_ref} = @result;
336 # We got a conflict when no flags are left, thus only PIE flags were
337 # missing. If other flags were missing abort because the conflict is not
339 return scalar @result == 0;
342 sub is_non_verbose_build {
343 my ($line, $next_line, $skip_ref) = @_;
345 if (not (index($line, 'checking if you want to see long compiling messages... no') == 0
346 or $line =~ /^\s*\[?(?:CC|CCLD|C\+\+|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/
347 or $line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
348 or $line =~ /^\s*[Bb]uilding (?:program|shared library)\s+(.+?)$/
349 or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
355 # C++ compiler setting.
356 return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
357 # "Compiling" with no file name.
358 if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) {
359 # $file_extension_regex may need spaces around the filename.
360 return 0 if not " $1 " =~ /$file_extension_regex/o;
365 # On the first pass we only check if this line is verbose or not.
366 return 1 if not defined $next_line;
368 # Second pass, we have access to the next line.
371 # CMake and other build systems print the non-verbose messages also when
372 # building verbose. If a compiler and the file name occurs in the next
373 # line, treat it as verbose build.
375 # Get filename, we can't use the complete path as only parts of it are
376 # used in the real compiler command.
377 $file =~ m{/([^/\s]+)$};
380 if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
381 # We still have to skip the current line as it doesn't contain any
391 sub compile_flag_regexp {
392 my ($flag_renames_ref, @flags) = @_;
395 foreach my $flag (@flags) {
396 # Store flag name in replacement string for correct flags in messages
397 # with qr//ed flag regexps.
398 $flag_renames_ref->{qr/\s$flag(?:\s|\\)/}
399 = (exists $flag_renames_ref->{$flag})
400 ? $flag_renames_ref->{$flag}
403 # Compile flag regexp for faster execution.
404 push @result, qr/\s$flag(?:\s|\\)/;
409 sub extension_found {
410 my ($extensions_ref, @extensions) = @_;
413 foreach my $extension (@extensions) {
414 if (exists $extensions_ref->{$extension}) {
425 # Parse command line arguments.
427 my $option_version = 0;
429 my $option_bindnow = 0;
430 my @option_ignore_arch = ();
431 my @option_ignore_flag = ();
432 my @option_ignore_line = ();
434 my $option_arch = undef;
435 my $option_buildd = 0;
437 if (not Getopt::Long::GetOptions(
438 'help|h|?' => \$option_help,
439 'version' => \$option_version,
441 'pie' => \$option_pie,
442 'bindnow' => \$option_bindnow,
443 'all' => \$option_all,
445 'ignore-arch=s' => \@option_ignore_arch,
446 'ignore-flag=s' => \@option_ignore_flag,
447 'ignore-line=s' => \@option_ignore_line,
449 'color' => \$option_color,
450 'arch=s' => \$option_arch,
451 'buildd' => \$option_buildd,
454 Pod::Usage::pod2usage(2);
458 Pod::Usage::pod2usage(1);
460 if ($option_version) {
461 print "blhc $VERSION Copyright (C) 2012 Simon Ruderich
463 This program is free software: you can redistribute it and/or modify
464 it under the terms of the GNU General Public License as published by
465 the Free Software Foundation, either version 3 of the License, or
466 (at your option) any later version.
468 This program is distributed in the hope that it will be useful,
469 but WITHOUT ANY WARRANTY; without even the implied warranty of
470 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
471 GNU General Public License for more details.
473 You should have received a copy of the GNU General Public License
474 along with this program. If not, see <http://www.gnu.org/licenses/>.
480 if (scalar @ARGV == 0) {
482 Pod::Usage::pod2usage(2);
485 # Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not
486 # installed on Debian's buildds.
487 if (not $option_buildd) {
488 require Term::ANSIColor;
496 # Strip flags which should be ignored.
497 if (scalar @option_ignore_flag > 0) {
498 my %ignores = map { $_ => 1 } @option_ignore_flag;
499 foreach my $flags (@flag_refs) {
501 # Flag found as string.
502 not exists $ignores{$_}
503 # Flag found as string representation of regexp.
504 and (not defined $flag_renames{$_}
505 or not exists $ignores{$flag_renames{$_}})
510 # Precompile all flag regexps. any_flags_used(), all_flags_used() get a lot
512 foreach my $flags (@flag_refs_all) {
513 @{$flags} = compile_flag_regexp(\%flag_renames, @{$flags});
516 # Precompile ignore line regexps, also anchor at beginning and end of line.
517 foreach my $ignore (@option_ignore_line) {
518 $ignore = qr/^$ignore$/;
525 foreach my $file (@ARGV) {
526 print "checking '$file'...\n" if scalar @ARGV > 1;
528 open my $fh, '<', $file or die "$!: $file";
530 # Architecture of this file.
531 my $arch = $option_arch;
533 # Hardening options. Not all architectures support all hardening options.
534 my $harden_format = 1;
535 my $harden_fortify = 1;
536 my $harden_stack = 1;
537 my $harden_relro = 1;
538 my $harden_bindnow = $option_bindnow; # defaults to 0
539 my $harden_pie = $option_pie; # defaults to 0
541 while (my $line = <$fh>) {
542 # Detect architecture automatically unless overridden. For buildd logs
543 # only, doesn't use the dpkg-buildpackage header. Necessary to ignore
544 # build logs which aren't built (wrong architecture, build error,
547 and $line =~ /^Architecture: (.+)$/) {
551 # dpkg-buildflags only provides hardening flags since 1.16.1, don't
552 # check for hardening flags in buildd mode if an older dpkg-dev is
553 # used. Default flags (-g -O2) are still checked.
555 # Packages which were built before 1.16.1 but used their own hardening
556 # flags are not checked.
558 and index($line, 'Toolchain package versions: ') == 0) {
559 require Dpkg::Version;
560 if (not $line =~ /\bdpkg-dev_(\S+)/
561 or Dpkg::Version::version_compare($1, '1.16.1') < 0) {
571 # The following two versions of CMake in Debian obeyed CPPFLAGS, but
572 # this was later dropped because upstream rejected the patch. Thus
573 # build logs with these versions will have fortify hardening flags
574 # enabled, even though they may be not correctly set and are missing
575 # when build with later CMake versions. Thanks to Aron Xu for letting
577 if (index($line, 'Package versions: ') == 0
578 and $line =~ /\bcmake_(\S+)/
579 and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
580 if (not $option_buildd) {
581 error_invalid_cmake($1);
583 print "W-invalid-cmake-used $1\n";
585 $exit |= $exit_code{invalid_cmake};
588 # If hardening wrapper is used (wraps calls to gcc and adds hardening
589 # flags automatically) we can't perform any checks, abort.
590 if (index($line, 'Build-Depends: ') == 0
591 and $line =~ /\bhardening-wrapper\b/) {
592 if (not $option_buildd) {
593 error_hardening_wrapper();
595 print "I-hardening-wrapper-used\n";
597 $exit |= $exit_code{hardening_wrapper};
601 # We skip over unimportant lines at the beginning of the log to
602 # prevent false positives.
603 last if index($line, 'dpkg-buildpackage: ') == 0;
606 # Input lines, contain only the lines with compiler commands.
609 my $continuation = 0;
610 my $complete_line = undef;
611 while (my $line = <$fh>) {
612 # And stop at the end of the build log. Package details (reported by
613 # the buildd logs) are not important for us. This also prevents false
615 last if $line =~ /^Build finished at \d{8}-\d{4}$/;
617 # Detect architecture automatically unless overridden.
619 and $line =~ /^dpkg-buildpackage: host architecture (.+)$/) {
623 # Ignore compiler warnings for now.
624 next if $line =~ /$warning_regex/o;
626 if (not $option_buildd and index($line, "\033") != -1) { # esc
627 # Remove all ANSI color sequences which are sometimes used in
628 # non-verbose builds.
629 $line = Term::ANSIColor::colorstrip($line);
630 # Also strip '\0xf' (delete previous character), used by Elinks'
633 # And "ESC(B" which seems to be used on armhf and hurd (not sure
635 $line =~ s/\033\(B//g;
638 # Check if this line indicates a non verbose build.
639 my $non_verbose = is_non_verbose_build($line);
641 # One line may contain multiple commands (";"). Treat each one as
642 # single line. parse_line() is slow, only use it when necessary.
643 my @line = (index($line, ';') == -1)
646 # Ensure newline at the line end - necessary for
647 # correct parsing later.
650 } Text::ParseWords::parse_line(';', 1, $line);
651 foreach my $line (@line) {
655 # Join lines, but leave the "\" in place so it's clear where
656 # the original line break was.
657 chomp $complete_line;
658 $complete_line .= ' ' . $line;
660 # Line continuation, line ends with "\".
661 if ($line =~ /\\$/) {
663 # Start line continuation.
664 if (not defined $complete_line) {
665 $complete_line = $line;
670 # Use the complete line if a line continuation occurred.
671 if (defined $complete_line) {
672 $line = $complete_line;
673 $complete_line = undef;
676 # Ignore lines with no compiler commands.
677 next if not $non_verbose
678 and not $line =~ /\b$cc_regex(?:\s|\\)/o;
679 # Ignore lines with no filenames with extensions. May miss some
680 # non-verbose builds (e.g. "gcc -o test" [sic!]), but shouldn't be
681 # a problem as the log will most likely contain other non-verbose
682 # commands which are detected.
683 next if not $non_verbose
684 and not $line =~ /$file_extension_regex/o;
686 # Ignore false positives.
688 # `./configure` output.
689 next if not $non_verbose
690 and $line =~ /^(?:checking|[Cc]onfigure:) /;
691 next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
692 [Cc]ompiler[\s.]*:?\s+
694 next if $line =~ /^\s*(?:- )?(?:HOST_)?(?:CC|CXX)\s*=\s*$cc_regex_full\s*$/o;
696 # Check if additional hardening options were used. Used to ensure
697 # they are used for the complete build.
698 $harden_pie = 1 if any_flags_used($line, @def_cflags_pie, @def_ldflags_pie);
699 $harden_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
707 # Ignore arch if requested.
708 if (scalar @option_ignore_arch > 0 and $arch) {
709 foreach my $ignore (@option_ignore_arch) {
710 if ($arch eq $ignore) {
711 print "ignoring architecture '$arch'\n";
717 if (scalar @input == 0) {
718 if (not $option_buildd) {
719 print "No compiler commands!\n";
721 print "W-no-compiler-commands\n";
723 $exit |= $exit_code{no_compiler_commands};
727 if ($option_buildd) {
728 $statistics{commands} += scalar @input;
731 # Option or auto detected.
733 # The following was partially copied from dpkg-dev 1.16.1.2
734 # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, add_hardening_flags()),
735 # copyright Raphaël Hertzog <hertzog@debian.org>, Kees Cook
736 # <kees@debian.org>, Canonical, Ltd. licensed under GPL version 2 or
737 # later. Keep it in sync.
740 my ($abi, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
742 # Disable unsupported hardening options.
743 if ($cpu =~ /^(?:ia64|alpha|mips|mipsel|hppa)$/ or $arch eq 'arm') {
746 if ($cpu =~ /^(?:ia64|hppa|avr32)$/) {
753 my @cflags = @def_cflags;
754 my @cxxflags = @def_cxxflags;
755 my @cppflags = @def_cppflags;
756 my @ldflags = @def_ldflags;
757 # Check the specified hardening options, same order as dpkg-buildflags.
759 @cflags = (@cflags, @def_cflags_pie);
760 @cxxflags = (@cxxflags, @def_cflags_pie);
761 @ldflags = (@ldflags, @def_ldflags_pie);
764 @cflags = (@cflags, @def_cflags_stack);
765 @cxxflags = (@cxxflags, @def_cflags_stack);
767 if ($harden_fortify) {
768 @cflags = (@cflags, @def_cflags_fortify);
769 @cxxflags = (@cxxflags, @def_cflags_fortify);
770 @cppflags = (@cppflags, @def_cppflags_fortify);
772 if ($harden_format) {
773 @cflags = (@cflags, @def_cflags_format);
774 @cxxflags = (@cxxflags, @def_cflags_format);
777 @ldflags = (@ldflags, @def_ldflags_relro);
779 if ($harden_bindnow) {
780 @ldflags = (@ldflags, @def_ldflags_bindnow);
784 for (my $i = 0; $i < scalar @input; $i++) {
785 my $line = $input[$i];
787 # Ignore line if requested.
788 foreach my $ignore (@option_ignore_line) {
789 next LINE if $line =~ /$ignore/;
793 if (is_non_verbose_build($line, $input[$i + 1], \$skip)) {
794 if (not $option_buildd) {
795 error_non_verbose_build($line);
797 $statistics{commands_nonverbose}++;
799 $exit |= $exit_code{non_verbose_build};
802 # Even if it's a verbose build, we might have to skip this line.
805 # Remove everything until and including the compiler command. Makes
806 # checks easier and faster.
807 $line =~ s/^.*?$cc_regex//o;
808 # "([...] test.c)" is not detected as 'test.c' - fix this by removing
809 # the brace and similar characters.
810 $line =~ s/['")]+$//;
812 # Skip unnecessary tests when only preprocessing.
813 my $flag_preprocess = 0;
820 # Preprocess, compile, assemble.
821 if ($line =~ /\s(-E|-S|-c)\b/) {
823 $flag_preprocess = 1 if $1 eq '-E';
824 $compile = 1 if $1 eq '-S' or $1 eq '-c';
825 # Dependency generation for Makefiles. The other flags (-MF -MG -MP
826 # -MT -MQ) are always used with -M/-MM.
827 } elsif ($line =~ /\s(?:-M|-MM)\b/) {
829 # Otherwise assume we are linking.
834 # -MD/-MMD also cause dependency generation, but they don't imply -E!
835 if ($line =~ /\s(?:-MD|-MMD)\b/) {
837 $flag_preprocess = 0;
840 # Dependency generation for Makefiles, no preprocessing or other flags
844 # Get all file extensions on this line.
845 my @extensions = $line =~ /$file_extension_regex/go;
846 # Ignore all unknown extensions to speedup the search below.
847 @extensions = grep { exists $extension{$_} } @extensions;
849 # These file types don't require preprocessing.
850 if (extension_found(\%extensions_no_preprocess, @extensions)) {
853 # These file types require preprocessing.
854 if (extension_found(\%extensions_preprocess, @extensions)) {
858 # If there are source files then it's compiling/linking in one step
859 # and we must check both. We only check for source files here, because
860 # header files cause too many false positives.
861 if (not $flag_preprocess
862 and extension_found(\%extensions_compile_link, @extensions)) {
863 # Assembly files don't need CFLAGS.
864 if (not extension_found(\%extensions_compile, @extensions)
865 and extension_found(\%extensions_no_compile, @extensions)) {
873 # Assume CXXFLAGS are required when a C++ file is specified in the
877 and extension_found(\%extensions_compile_cpp, @extensions)) {
882 if ($option_buildd) {
883 $statistics{preprocess}++ if $preprocess;
884 $statistics{compile}++ if $compile;
885 $statistics{compile_cpp}++ if $compile_cpp;
886 $statistics{link}++ if $link;
889 # Check hardening flags.
891 if ($compile 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 CFLAGS`') == -1) {
898 if (not $option_buildd) {
899 error_flags('CFLAGS missing', \@missing, \%flag_renames, $input[$i]);
901 $statistics{compile_missing}++;
903 $exit |= $exit_code{flags_missing};
904 } elsif ($compile_cpp and not all_flags_used($line, \@missing, @cflags)
905 # Libraries linked with -fPIC don't have to (and can't) be
906 # linked with -fPIE as well. It's no error if only PIE flags
908 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
909 # Assume dpkg-buildflags returns the correct flags.
910 and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
911 if (not $option_buildd) {
912 error_flags('CXXFLAGS missing', \@missing, \%flag_renames, $input[$i]);
914 $statistics{compile_cpp_missing}++;
916 $exit |= $exit_code{flags_missing};
918 if ($preprocess and not all_flags_used($line, \@missing, @cppflags)
919 # Assume dpkg-buildflags returns the correct flags.
920 and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
921 if (not $option_buildd) {
922 error_flags('CPPFLAGS missing', \@missing, \%flag_renames, $input[$i]);
924 $statistics{preprocess_missing}++;
926 $exit |= $exit_code{flags_missing};
928 if ($link and not all_flags_used($line, \@missing, @ldflags)
929 # Same here, -fPIC conflicts with -fPIE.
930 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie)
931 # Assume dpkg-buildflags returns the correct flags.
932 and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
933 if (not $option_buildd) {
934 error_flags('LDFLAGS missing', \@missing, \%flag_renames, $input[$i]);
936 $statistics{link_missing}++;
938 $exit |= $exit_code{flags_missing};
943 # Print statistics for buildd mode, only output in this mode.
944 if ($option_buildd) {
947 if ($statistics{preprocess_missing}) {
948 push @warning, sprintf 'CPPFLAGS %d (of %d)',
949 $statistics{preprocess_missing},
950 $statistics{preprocess};
952 if ($statistics{compile_missing}) {
953 push @warning, sprintf 'CFLAGS %d (of %d)',
954 $statistics{compile_missing},
955 $statistics{compile};
957 if ($statistics{compile_cpp_missing}) {
958 push @warning, sprintf 'CXXFLAGS %d (of %d)',
959 $statistics{compile_cpp_missing},
960 $statistics{compile_cpp};
962 if ($statistics{link_missing}) {
963 push @warning, sprintf 'LDFLAGS %d (of %d)',
964 $statistics{link_missing},
967 if (scalar @warning) {
968 local $" = ', '; # array join string
969 print "W-dpkg-buildflags-missing @warning missing\n";
972 if ($statistics{commands_nonverbose}) {
973 printf "W-compiler-flags-hidden %d (of %d) hidden\n",
974 $statistics{commands_nonverbose},
975 $statistics{commands},
987 blhc - build log hardening check, checks build logs for missing hardening flags
991 B<blhc> [I<options>] I<E<lt>dpkg-buildpackage build log fileE<gt>..>
995 blhc is a small tool which checks build logs for missing hardening flags. It's
996 licensed under the GPL 3 or later.
998 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
999 tools using dpkg-buildpackage like pbuilder or the official buildd build logs)
1000 to help maintainers detect missing hardening flags in their packages.
1008 Force check for all +all (+pie, +bindnow) hardening flags. By default it's
1011 =item B<--arch> I<architecture>
1013 Set the specific architecture (e.g. amd64, armel, etc.), automatically
1014 disables hardening flags not available on this architecture. Is detected
1015 automatically if dpkg-buildpackage is used.
1019 Force check for all +bindnow hardening flags. By default it's auto detected.
1023 Special mode for buildds when automatically parsing log files. The following
1024 changes are in effect:
1030 Print tags instead of normal warnings, see L</"BUILDD TAGS"> for a list of
1035 Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is
1040 Don't require Term::ANSIColor.
1046 Use colored (ANSI) output for warning messages.
1048 =item B<--ignore-arch> I<arch>
1050 Ignore build logs from architectures matching I<arch>. I<arch> is a string.
1052 Used to prevent false positives. This option can be specified multiple times.
1054 =item B<--ignore-flag> I<flag>
1056 Don't print an error when the specific flag is missing in a compiler line.
1057 I<flag> is a string.
1059 Used to prevent false positives. This option can be specified multiple times.
1061 =item B<--ignore-line> I<regex>
1063 Ignore lines matching the given Perl regex. I<regex> is automatically anchored
1064 at the beginning and end of the line to prevent false negatives.
1066 B<NOTE>: Not the input lines are checked, but the lines which are displayed in
1067 warnings (which have line continuation resolved).
1069 Used to prevent false positives. This option can be specified multiple times.
1073 Force check for all +pie hardening flags. By default it's auto detected.
1075 =item B<-h -? --help>
1077 Print available options.
1081 Print version number and license.
1085 Auto detection for B<--pie> and B<--bindnow> only works if at least one
1086 command uses the required hardening flag (e.g. -fPIE). Then it's required for
1087 all other commands as well.
1091 Normal usage, parse a single log file.
1093 blhc path/to/log/file
1095 Parse multiple log files. The exit code is ORed over all files.
1097 blhc path/to/directory/with/log/files/*
1099 Don't treat missing C<-g> as error:
1101 blhc --ignore-flag -g path/to/log/file
1103 Ignore lines consisting exactly of C<./script gcc file> which would cause a
1106 blhc --ignore-line '\./script gcc file' path/to/log/file
1108 Ignore lines matching C<./script gcc file> somewhere in the line.
1110 blhc --ignore-line '.*\./script gcc file.*' path/to/log/file
1112 Use blhc with pbuilder.
1114 pbuilder path/to/package.dsc | tee path/log/file
1115 blhc path/to/file || echo flags missing
1119 The following tags are used in I<--buildd> mode. In braces the additional data
1126 B<I-hardening-wrapper-used>
1128 The package uses hardening-wrapper which intercepts calls to gcc and adds
1129 hardening flags. The build log doesn't contain any hardening flags and thus
1130 can't be checked by blhc.
1134 B<W-compiler-flags-hidden> (summary of hidden lines)
1136 Build log contains lines which hide the real compiler flags. For example:
1143 Most of the time either C<export V=1> or C<export verbose=1> in
1144 F<debian/rules> fixes builds with hidden compiler flags. Sometimes C<.SILENT>
1145 in a F<Makefile> must be removed. And as last resort the F<Makefile> must be
1146 patched to remove the C<@>s hiding the real compiler commands.
1150 B<W-dpkg-buildflags-missing> (summary of missing flags)
1152 CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
1156 B<W-invalid-cmake-used> (version)
1160 B<W-no-compiler-commands>
1162 No compiler commands were detected. Either the log contains none or they were
1163 not correctly detected by blhc (please report the bug in this case).
1169 The exit status is a "bit mask", each listed status is ORed when the error
1170 condition occurs to get the result.
1180 No compiler commands were found.
1184 Invalid arguments/options given to blhc.
1192 Missing hardening flags.
1196 Hardening wrapper detected, no tests performed.
1202 Simon Ruderich, E<lt>simon@ruderich.orgE<gt>
1204 Thanks to to Bernhard R. Link E<lt>brlink@debian.orgE<gt> and Jaria Alto
1205 E<lt>jari.aalto@cante.netE<gt> for their valuable input and suggestions.
1207 =head1 COPYRIGHT AND LICENSE
1209 Copyright (C) 2012 by Simon Ruderich
1211 This program is free software: you can redistribute it and/or modify
1212 it under the terms of the GNU General Public License as published by
1213 the Free Software Foundation, either version 3 of the License, or
1214 (at your option) any later version.
1216 This program is distributed in the hope that it will be useful,
1217 but WITHOUT ANY WARRANTY; without even the implied warranty of
1218 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1219 GNU General Public License for more details.
1221 You should have received a copy of the GNU General Public License
1222 along with this program. If not, see <http://www.gnu.org/licenses/>.
1226 L<hardening-check(1)>, L<dpkg-buildflags(1)>