3 # Build log hardening check, checks build logs for missing hardening flags.
5 # Copyright (C) 2012-2020 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.11';
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\+\+|gfortran|mpicc|mpicxx|mpifort)
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_prefix = qr/
42 [a-z0-9_]+-(?:linux-|kfreebsd-)?gnu(?:eabi|eabihf)?
44 my $cc_regex_full = qr/
45 (?:$cc_regex_full_prefix-)?
48 # Regex to check if a line contains a compiler command.
49 my $cc_regex_normal = qr/
52 # Regex to catch (GCC) compiler warnings.
53 my $warning_regex = qr/^(.+?):(\d+):\d+: warning: (.+?) \[(.+?)\]$/;
54 # Regex to catch libtool commands and not lines which show commands executed
55 # by libtool (e.g. libtool: link: ...).
56 my $libtool_regex = qr/\blibtool["']?\s.*--mode=/;
57 my $libtool_link_regex = qr/\blibtool: link: /;
59 # List of source file extensions which require preprocessing.
60 my @source_preprocess_compile_cpp = (
62 qw( cc cp cxx cpp CPP c++ C ),
66 my @source_preprocess_compile_fortran = (
68 qw( F FOR fpp FPP FTN F90 F95 F03 F08 ),
70 my @source_preprocess_compile = (
76 @source_preprocess_compile_cpp,
78 @source_preprocess_compile_fortran,
80 my @source_preprocess_no_compile = (
84 my @source_preprocess = (
85 @source_preprocess_compile,
86 @source_preprocess_no_compile,
88 # List of source file extensions which don't require preprocessing.
89 my @source_no_preprocess_compile_cpp = (
95 my @source_no_preprocess_compile_ada = (
101 my @source_no_preprocess_compile_fortran = (
103 qw( f for ftn f90 f95 f03 f08 ),
105 my @source_no_preprocess_compile = (
109 @source_no_preprocess_compile_cpp,
113 @source_no_preprocess_compile_fortran,
115 @source_no_preprocess_compile_ada,
117 my @source_no_preprocess_no_compile_ada = (
121 my @source_no_preprocess_no_compile = (
125 @source_no_preprocess_no_compile_ada,
127 my @source_no_preprocess = (
128 @source_no_preprocess_compile,
129 @source_no_preprocess_no_compile,
131 # List of header file extensions which require preprocessing.
132 my @header_preprocess = (
133 # C, C++, Objective-C, Objective-C++
136 qw( hh H hp hxx hpp HPP h++ tcc ),
140 # Normal object files.
142 # Libtool object files.
144 # Dynamic libraries. bzip2 uses .sho.
150 # Hashes for fast extensions lookup to check if a file falls in one of these
152 my %extensions_no_preprocess = map { $_ => 1 } (
153 # There's no @header_no_preprocess.
154 @source_no_preprocess,
156 my %extensions_preprocess = map { $_ => 1 } (
160 my %extensions_compile_link = map { $_ => 1 } (
162 @source_no_preprocess,
164 my %extensions_compile = map { $_ => 1 } (
165 @source_preprocess_compile,
166 @source_no_preprocess_compile,
168 my %extensions_no_compile = map { $_ => 1 } (
169 @source_preprocess_no_compile,
170 @source_no_preprocess_no_compile,
172 my %extensions_compile_cpp = map { $_ => 1 } (
173 @source_preprocess_compile_cpp,
174 @source_no_preprocess_compile_cpp,
176 my %extensions_ada = map { $_ => 1 } (
177 @source_no_preprocess_compile_ada,
178 @source_no_preprocess_no_compile_ada,
180 my %extensions_fortran = map { $_ => 1 } (
181 @source_no_preprocess_compile_fortran,
182 @source_preprocess_compile_fortran,
184 my %extensions_object = map { $_ => 1 } (
187 my %extension = map { $_ => 1 } (
188 @source_no_preprocess,
194 # Regexp to match file extensions.
195 my $file_extension_regex = qr/
197 \S+ # Filename without extension.
199 ([^\/\\.,;:\s]+)# File extension.
200 (?=\s|\\) # At end of word. Can't use \b because some files have non
201 # word characters at the end and because \b matches double
202 # extensions (like .cpp.o). Works always as all lines are
203 # terminated with "\n".
206 # Expected (hardening) flags. All flags are used as regexps (and compiled to
207 # real regexps below for better execution speed).
210 '-O(?:2|3)', # keep at index 1, search for @def_cflags_debug to change it
212 my @def_cflags_debug = (
213 # These flags indicate a debug build which disables checks for -O2.
217 my @def_cflags_format = (
218 '-Wformat(?:=2)?', # -Wformat=2 implies -Wformat, accept it too
219 '-Werror=format-security', # implies -Wformat-security
221 my @def_cflags_fortify = (
222 # fortify needs at least -O1, but -O2 is recommended anyway
224 my @def_cflags_stack = (
225 '-fstack-protector', # keep first, used by cflags_stack_broken()
226 '--param[= ]ssp-buffer-size=4',
228 my @def_cflags_stack_strong = (
229 '-fstack-protector-strong', # keep first, used by cflags_stack_broken()
231 my @def_cflags_stack_bad = (
232 # Blacklist all stack protector options for simplicity.
233 '-fno-stack-protector',
234 '-fno-stack-protector-all',
235 '-fno-stack-protector-strong',
237 my @def_cflags_pie = (
243 # @def_cxxflags_* is the same as @def_cflags_*.
244 my @def_cppflags = ();
245 my @def_cppflags_fortify = (
246 '-D_FORTIFY_SOURCE=2', # must be first, see cppflags_fortify_broken()
247 # If you add another flag fix hack below (search for "Hack to fix") and
248 # $def_cppflags_fortify[0].
250 my @def_cppflags_fortify_bad = (
251 # These flags may overwrite -D_FORTIFY_SOURCE=2.
253 '-D_FORTIFY_SOURCE=0',
254 '-D_FORTIFY_SOURCE=1',
256 my @def_ldflags = ();
257 my @def_ldflags_relro = (
260 my @def_ldflags_bindnow = (
263 my @def_ldflags_pie = (
267 my @def_ldflags_pic = (
272 # References to all flags checked by the flag checker.
276 \@def_cflags_fortify,
278 \@def_cflags_stack_strong,
279 \@def_cflags_stack_bad,
283 \@def_cppflags_fortify,
286 \@def_ldflags_bindnow,
289 # References to all used flags.
290 my @flag_refs_all = (
293 \@def_cppflags_fortify_bad,
296 # Renaming rules for the output so the regex parts are not visible. Also
297 # stores string values of flag regexps above, see compile_flag_regexp().
299 '-O(?:2|3)' => '-O2',
300 '-Wformat(?:=2)?' => '-Wformat',
301 '--param[= ]ssp-buffer-size=4' => '--param=ssp-buffer-size=4',
302 '-Wl,(?:-z,)?relro' => '-Wl,-z,relro',
303 '-Wl,(?:-z,)?now' => '-Wl,-z,now',
307 no_compiler_commands => 1 << 0,
308 # used by POD::Usage => 1 << 1,
309 non_verbose_build => 1 << 2,
310 flags_missing => 1 << 3,
311 hardening_wrapper => 1 << 4,
312 invalid_cmake => 1 << 5,
316 no_compiler_commands => 'I-no-compiler-commands',
317 non_verbose_build => 'W-compiler-flags-hidden',
318 flags_missing => 'W-dpkg-buildflags-missing',
319 hardening_wrapper => 'I-hardening-wrapper-used',
320 invalid_cmake => 'I-invalid-cmake-used',
323 # Statistics of missing flags and non-verbose build commands. Used for
327 preprocess_missing => 0,
329 compile_missing => 0,
331 compile_cpp_missing => 0,
335 commands_nonverbose => 0,
338 # Use colored (ANSI) output?
344 # Only works for single-level arrays with no undef values. Thanks to perlfaq4.
346 my ($first_ref, $second_ref) = @_;
348 return 0 if scalar @{$first_ref} != scalar @{$second_ref};
350 my $length = scalar @{$first_ref};
351 for (my $i = 0; $i < $length; $i++) {
352 return 0 if $first_ref->[$i] ne $second_ref->[$i];
359 my ($message, $missing_flags_ref, $flag_renames_ref, $line, $number) = @_;
361 # Get string value of qr//-escaped regexps and if requested rename them.
362 my @missing_flags = map {
363 $flag_renames_ref->{$_}
364 } @{$missing_flags_ref};
366 my $flags = join ' ', @missing_flags;
367 printf '%d:', $number if defined $number;
368 printf '%s (%s)%s %s',
369 error_color($message, 'red'), $flags, error_color(':', 'yellow'),
374 sub error_non_verbose_build {
375 my ($line, $number) = @_;
377 printf '%d:', $number if defined $number;
379 error_color('NONVERBOSE BUILD', 'red'),
380 error_color(':', 'yellow'),
385 sub error_invalid_cmake {
389 error_color('INVALID CMAKE', 'red'),
390 error_color(':', 'yellow'),
395 sub error_hardening_wrapper {
397 error_color('HARDENING WRAPPER', 'red'),
398 error_color(':', 'yellow'),
399 'no checks possible, aborting';
404 my ($message, $color) = @_;
407 return Term::ANSIColor::colored($message, $color);
414 my ($line, @flags) = @_;
416 foreach my $flag (@flags) {
417 return 1 if $line =~ /$flag/;
423 my ($line, $missing_flags_ref, @flags) = @_;
425 my @missing_flags = ();
426 foreach my $flag (@flags) {
427 if (not $line =~ /$flag/) {
428 push @missing_flags, $flag;
432 return 1 if scalar @missing_flags == 0;
434 @{$missing_flags_ref} = @missing_flags;
437 # Check if any of \@bad_flags occurs after $good_flag. Doesn't check if
438 # $good_flag is present.
439 sub flag_overwritten {
440 my ($line, $good_flag, $bad_flags) = @_;
442 if (not any_flags_used($line, @{$bad_flags})) {
447 foreach my $flag (@{$bad_flags}) {
448 while ($line =~ /$flag/g) {
449 if ($bad_pos < $+[0]) {
455 while ($line =~ /$good_flag/g) {
458 if ($good_pos > $bad_pos) {
464 sub cppflags_fortify_broken {
465 my ($line, $missing_flags) = @_;
467 # $def_cppflags_fortify[0] must be -D_FORTIFY_SOURCE=2!
468 my $fortify_source = $def_cppflags_fortify[0];
470 # Some build systems enable/disable fortify source multiple times, check
472 if (not flag_overwritten($line,
474 \@def_cppflags_fortify_bad)) {
477 push @{$missing_flags}, $fortify_source;
481 sub cflags_stack_broken {
482 my ($line, $missing_flags, $strong) = @_;
484 my $flag = $strong ? $def_cflags_stack_strong[0]
485 : $def_cflags_stack[0];
487 if (not flag_overwritten($line, $flag, \@def_cflags_stack_bad)) {
490 push @{$missing_flags}, $flag;
494 # Modifies $missing_flags_ref array.
495 sub pic_pie_conflict {
496 my ($line, $pie, $missing_flags_ref, @flags_pie) = @_;
498 return 0 if not $pie;
499 return 0 if not any_flags_used($line, @def_ldflags_pic);
501 my %flags = map { $_ => 1 } @flags_pie;
503 # Remove all PIE flags from @missing_flags as they are not required with
506 not exists $flags{$_}
507 } @{$missing_flags_ref};
508 @{$missing_flags_ref} = @result;
510 # We got a conflict when no flags are left, thus only PIE flags were
511 # missing. If other flags were missing abort because the conflict is not
513 return scalar @result == 0;
516 sub is_non_verbose_build {
517 my ($line, $skip_ref, $input_ref, $line_offset, $line_count) = @_;
519 if ($line =~ /$libtool_regex/o) {
520 # libtool's --silent hides the real compiler flags.
521 if ($line =~ /\s--silent/) {
523 # If --silent is not present, skip this line as some compiler flags
524 # might be missing (e.g. -fPIE) which are handled correctly by libtool
525 # internally. libtool displays the real compiler command on the next
526 # line, so the flags are checked as usual.
533 if (not (index($line, 'checking if you want to see long compiling messages... no') == 0
534 or $line =~ /^\s*\[?(?:CC|CCLD|C\+\+|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/
535 or $line =~ /^\s*[][\/0-9 ]*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
536 or $line =~ /^\s*[Bb]uilding (?:program|shared library)\s+(.+?)$/
537 or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
543 # C++ compiler setting.
544 return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
545 return 0 if $line =~ /^\s*C\+\+ Library: stdc\+\+$/;
546 # "Compiling" non binary files.
547 return 0 if $line =~ /^\s*Compiling \S+\.(?:py|pyx|el)['"]?\s*(?:\.\.\.|because it changed\.)?$/;
548 return 0 if $line =~ /^\s*[Cc]ompiling catalog \S+\.po\b/;
549 # "Compiling" with no file name.
550 if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) {
551 # $file_extension_regex may need spaces around the filename.
552 return 0 if not " $1 " =~ /$file_extension_regex/o;
557 # On the first pass we only check if this line is verbose or not.
558 return 1 if not defined $input_ref;
560 # Second pass, we have access to the next lines.
563 # CMake and other build systems print the non-verbose messages also when
564 # building verbose. If a compiler and the file name occurs in the next
565 # lines, treat it as verbose build.
567 # Get filename, we can't use the complete path as only parts of it are
568 # used in the real compiler command.
569 $file =~ m{/([^/\s]+)$};
572 for (my $i = 1; $i <= $line_count; $i++) {
573 my $next_line = $input_ref->[$line_offset + $i];
574 last unless defined $next_line;
576 if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
577 # Not a non-verbose line, but we still have to skip the
578 # current line as it doesn't contain any compiler commands.
588 # Remove @flags from $flag_refs_ref, uses $flag_renames_ref as reference.
590 my ($flag_refs_ref, $flag_renames_ref, @flags) = @_;
592 my %removes = map { $_ => 1 } @flags;
593 foreach my $flags (@{$flag_refs_ref}) {
595 # Flag found as string.
596 not exists $removes{$_}
597 # Flag found as string representation of regexp.
598 and (not defined $flag_renames_ref->{$_}
599 or not exists $removes{$flag_renames_ref->{$_}})
606 # Modifies $flag_renames_ref hash.
607 sub compile_flag_regexp {
608 my ($flag_renames_ref, @flags) = @_;
611 foreach my $flag (@flags) {
612 # Compile flag regexp for faster execution.
613 my $regex = qr/\s$flag(?:\s|\\)/;
615 # Store flag name in replacement string for correct flags in messages
616 # with qr//ed flag regexps.
617 $flag_renames_ref->{$regex}
618 = (exists $flag_renames_ref->{$flag})
619 ? $flag_renames_ref->{$flag}
622 push @result, $regex;
627 # Does any extension in @extensions exist in %{$extensions_ref}?
628 sub extension_found {
629 my ($extensions_ref, @extensions) = @_;
631 foreach my $extension (@extensions) {
632 if (exists $extensions_ref->{$extension}) {
642 # Parse command line arguments.
644 my $option_version = 0;
646 my $option_bindnow = 0;
647 my @option_ignore_arch = ();
648 my @option_ignore_flag = ();
649 my @option_ignore_arch_flag = ();
650 my @option_ignore_line = ();
651 my @option_ignore_arch_line = ();
653 my $option_arch = undef;
654 my $option_buildd = 0;
655 my $option_debian = 0;
657 my $option_line_numbers = 0;
658 if (not Getopt::Long::GetOptions(
659 'help|h|?' => \$option_help,
660 'version' => \$option_version,
662 'pie' => \$option_pie,
663 'bindnow' => \$option_bindnow,
664 'all' => \$option_all,
666 'ignore-arch=s' => \@option_ignore_arch,
667 'ignore-flag=s' => \@option_ignore_flag,
668 'ignore-arch-flag=s' => \@option_ignore_arch_flag,
669 'ignore-line=s' => \@option_ignore_line,
670 'ignore-arch-line=s' => \@option_ignore_arch_line,
672 'color' => \$option_color,
673 'arch=s' => \$option_arch,
674 'buildd' => \$option_buildd,
675 'debian' => \$option_debian,
676 'line-numbers' => \$option_line_numbers,
679 Pod::Usage::pod2usage(2);
683 Pod::Usage::pod2usage(1);
685 if ($option_version) {
687 blhc $VERSION Copyright (C) 2012-2020 Simon Ruderich
689 This program is free software: you can redistribute it and/or modify
690 it under the terms of the GNU General Public License as published by
691 the Free Software Foundation, either version 3 of the License, or
692 (at your option) any later version.
694 This program is distributed in the hope that it will be useful,
695 but WITHOUT ANY WARRANTY; without even the implied warranty of
696 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
697 GNU General Public License for more details.
699 You should have received a copy of the GNU General Public License
700 along with this program. If not, see <http://www.gnu.org/licenses/>.
706 if (scalar @ARGV == 0) {
708 Pod::Usage::pod2usage(2);
711 # Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not
712 # installed on Debian's buildds.
713 if (not $option_buildd) {
714 require Term::ANSIColor;
722 # Precompiled ignores for faster lookup.
723 my %option_ignore_arch_flag = ();
724 my %option_ignore_arch_line = ();
726 # Strip flags which should be ignored.
727 if (scalar @option_ignore_flag > 0) {
728 remove_flags(\@flag_refs, \%flag_renames, @option_ignore_flag);
730 # Same for arch specific ignore flags, but only prepare here.
731 if (scalar @option_ignore_arch_flag > 0) {
732 foreach my $ignore (@option_ignore_arch_flag) {
733 my ($ignore_arch, $ignore_flag) = split /:/, $ignore, 2;
735 if (not $ignore_arch or not $ignore_flag) {
736 printf STDERR 'Value "%s" invalid for option ignore-arch-flag '
737 . '("arch:flag" expected)' . "\n", $ignore;
739 Pod::Usage::pod2usage(2);
742 push @{$option_ignore_arch_flag{$ignore_arch}}, $ignore_flag;
746 # Precompile all flag regexps. any_flags_used(), all_flags_used() get a lot
748 foreach my $flags (@flag_refs_all) {
749 @{$flags} = compile_flag_regexp(\%flag_renames, @{$flags});
752 # Precompile ignore line regexps, also anchor at beginning and end of line.
753 # Additional entries are also extracted from the build log, see below.
754 foreach my $ignore (@option_ignore_line) {
755 $ignore = qr/^$ignore$/;
757 # Same for arch specific ignore lines.
758 if (scalar @option_ignore_arch_line > 0) {
759 foreach my $ignore (@option_ignore_arch_line) {
760 my ($ignore_arch, $ignore_line) = split /:/, $ignore, 2;
762 if (not $ignore_arch or not $ignore_line) {
763 printf STDERR 'Value "%s" invalid for option ignore-arch-line '
764 . '("arch:line" expected)' . "\n", $ignore;
766 Pod::Usage::pod2usage(2);
769 push @{$option_ignore_arch_line{$ignore_arch}}, qr/^$ignore_line$/;
777 foreach my $file (@ARGV) {
778 print "checking '$file'...\n" if scalar @ARGV > 1;
780 -f $file or die "No such file: $file";
782 open my $fh, '<', $file or die $!;
784 # Architecture of this file.
785 my $arch = $option_arch;
787 # Hardening options. Not all architectures support all hardening options.
788 my $harden_format = 1;
789 my $harden_fortify = 1;
790 my $harden_stack = 1;
791 my $harden_stack_strong = 1;
792 my $harden_relro = 1;
793 my $harden_bindnow = $option_bindnow; # defaults to 0
794 my $harden_pie = $option_pie; # defaults to 0
796 # Number of parallel jobs to prevent false positives when detecting
797 # non-verbose builds. As not all jobs declare the number of parallel jobs
798 # use a large enough default.
801 # Don't check for PIE flags if automatically applied by the compiler. Only
802 # used in buildd and Debian mode.
803 my $disable_harden_pie = 0;
804 if ($option_debian) {
805 $disable_harden_pie = 1;
809 while (my $line = <$fh>) {
812 # Detect architecture automatically unless overridden. For buildd logs
813 # only, doesn't use the dpkg-buildpackage header. Necessary to ignore
814 # build logs which aren't built (wrong architecture, build error,
817 if (index($line, 'Build Architecture: ') == 0) {
818 $arch = substr $line, 20, -1; # -1 to ignore '\n' at the end
819 # For old logs (sbuild << 0.63.0-1).
820 } elsif (index($line, 'Architecture: ') == 0) {
821 $arch = substr $line, 14, -1; # -1 to ignore '\n' at the end
825 # dpkg-buildflags only provides hardening flags since 1.16.1, don't
826 # check for hardening flags in buildd mode if an older dpkg-dev is
827 # used. Default flags (-g -O2) are still checked.
829 # Packages which were built before 1.16.1 but used their own hardening
830 # flags are not checked.
832 # Strong stack protector is used since dpkg 1.17.11.
834 # Recent GCC versions automatically use PIE (only on supported
835 # architectures) and dpkg respects this properly since 1.18.15 and
836 # doesn't pass PIE flags manually.
838 and index($line, 'Toolchain package versions: ') == 0) {
839 require Dpkg::Version;
842 my $disable_strong = 1;
844 if ($line =~ /\bdpkg-dev_(\S+)/) {
845 if (Dpkg::Version::version_compare($1, '1.16.1') >= 0) {
848 if (Dpkg::Version::version_compare($1, '1.17.11') >= 0) {
851 if (Dpkg::Version::version_compare($1, '1.18.15') >= 0) {
852 $disable_harden_pie = 1;
864 if ($disable_strong) {
865 $harden_stack_strong = 0;
869 # The following two versions of CMake in Debian obeyed CPPFLAGS, but
870 # this was later dropped because upstream rejected the patch. Thus
871 # build logs with these versions will have fortify hardening flags
872 # enabled, even though they may be not correctly set and are missing
873 # when build with later CMake versions. Thanks to Aron Xu for letting
875 if (index($line, 'Package versions: ') == 0
876 and $line =~ /\bcmake_(\S+)/
877 and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
878 if (not $option_buildd) {
879 error_invalid_cmake($1);
880 $exit |= $exit_code{invalid_cmake};
882 print "$buildd_tag{invalid_cmake}|$1|\n";
886 # Debian's build daemons use "Filtered Build-Depends:" (or just
887 # "Build-Depends:" in older versions) for the build dependencies, but
888 # pbuilder uses "Depends:"; support both.
889 if (index($line, 'Filtered Build-Depends: ') == 0
890 or index($line, 'Build-Depends: ') == 0
891 or index($line, 'Depends: ') == 0) {
892 # If hardening wrapper is used (wraps calls to gcc and adds
893 # hardening flags automatically) we can't perform any checks,
895 if ($line =~ /\bhardening-wrapper\b/) {
896 if (not $option_buildd) {
897 error_hardening_wrapper();
898 $exit |= $exit_code{hardening_wrapper};
900 print "$buildd_tag{hardening_wrapper}||\n";
906 # This flags is not always available, but if it is use it.
907 if ($line =~ /^DEB_BUILD_OPTIONS=.*\bparallel=(\d+)/) {
911 # We skip over unimportant lines at the beginning of the log to
912 # prevent false positives.
913 last if index($line, 'dpkg-buildpackage: ') == 0;
916 # Input lines, contain only the lines with compiler commands.
918 # Non-verbose lines in the input. Used to reduce calls to
919 # is_non_verbose_build() (which is quite slow) in the second loop when
920 # it's already clear if a line is non-verbose or not.
921 my @input_nonverbose = ();
923 my @input_number = ();
925 my $continuation = 0;
926 my $complete_line = undef;
928 while (my $line = <$fh>) {
931 # And stop at the end of the build log. Package details (reported by
932 # the buildd logs) are not important for us. This also prevents false
934 last if index($line, 'Build finished at ') == 0
935 and $line =~ /^Build finished at \d{8}-\d{4}$/;
937 if (not $continuation) {
941 # Detect architecture automatically unless overridden.
943 and index($line, 'dpkg-buildpackage: info: host architecture ') == 0) {
944 $arch = substr $line, 43, -1; # -1 to ignore '\n' at the end
945 # Older versions of dpkg-buildpackage
947 and index($line, 'dpkg-buildpackage: host architecture ') == 0) {
948 $arch = substr $line, 37, -1; # -1 to ignore '\n' at the end
950 # Old buildd logs use e.g. "host architecture is alpha", remove
951 # the "is", otherwise debarch_to_debtriplet() will not detect the
953 if (index($arch, 'is ') == 0) {
954 $arch = substr $arch, 3;
958 # Permit dynamic excludes from within the build log to ignore false
959 # positives. Cannot use a separate config file as we often only have
960 # the build log itself.
961 if (index($line, 'blhc: ignore-line-regexp: ') == 0) {
962 my $ignore = substr $line, 26, -1; # -1 to ignore '\n' at the end
963 push @option_ignore_line, qr/^$ignore$/;
967 next if $line =~ /^\s*#/;
968 # Ignore compiler warnings for now.
969 next if $line =~ /$warning_regex/o;
971 if (not $option_buildd and index($line, "\033") != -1) { # \033 = esc
972 # Remove all ANSI color sequences which are sometimes used in
973 # non-verbose builds.
974 $line = Term::ANSIColor::colorstrip($line);
975 # Also strip '\0xf' (delete previous character), used by Elinks'
978 # And "ESC(B" which seems to be used on armhf and hurd (not sure
980 $line =~ s/\033\(B//g;
983 # Check if this line indicates a non verbose build.
985 $non_verbose |= is_non_verbose_build($line, \$skip);
988 # One line may contain multiple commands (";"). Treat each one as
989 # single line. parse_line() is slow, only use it when necessary.
990 my @line = (index($line, ';') == -1)
993 # Ensure newline at the line end - necessary for
994 # correct parsing later.
997 } Text::ParseWords::parse_line(';', 1, $line);
998 foreach my $line (@line) {
1002 # Join lines, but leave the "\" in place so it's clear where
1003 # the original line break was.
1004 chomp $complete_line;
1005 $complete_line .= ' ' . $line;
1007 # Line continuation, line ends with "\".
1008 if ($line =~ /\\$/) {
1010 # Start line continuation.
1011 if (not defined $complete_line) {
1012 $complete_line = $line;
1017 # Use the complete line if a line continuation occurred.
1018 if (defined $complete_line) {
1019 $line = $complete_line;
1020 $complete_line = undef;
1023 # Ignore lines with no compiler commands.
1024 next if not $non_verbose
1025 and not $line =~ /$cc_regex_normal/o;
1026 # Ignore lines with no filenames with extensions. May miss some
1027 # non-verbose builds (e.g. "gcc -o test" [sic!]), but shouldn't be
1028 # a problem as the log will most likely contain other non-verbose
1029 # commands which are detected.
1030 next if not $non_verbose
1031 and not $line =~ /$file_extension_regex/o;
1033 # Ignore false positives.
1035 # `./configure` output.
1036 next if not $non_verbose
1037 and $line =~ /^(?:checking|[Cc]onfigure:) /;
1038 next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
1039 [Cc]ompiler[\s.]*:?\s+
1041 next if $line =~ m{^\s*(?:-\s)?(?:HOST_)?(?:CC|CXX)
1042 \s*=\s*$cc_regex_full
1043 # optional compiler options, don't allow
1044 # "everything" here to prevent false negatives
1045 \s*(?:\s-\S+)*\s*$}xo;
1046 # `moc-qt4`/`moc-qt5` contain '-I.../linux-g++' in their command
1047 # line (or similar for other architectures) which gets recognized
1048 # as a compiler line, but `moc-qt*` is only a preprocessor for Qt
1049 # C++ files. No hardening flags are relevant during this step,
1050 # thus ignore `moc-qt*` lines. The resulting files will be
1051 # compiled in a separate step (and therefore checked).
1052 next if $line =~ m{^\S+/bin/moc(?:-qt[45])?
1054 -I\S+/mkspecs/[a-z]+-g\++(?:-64)?
1056 # Ignore false positives when the line contains only CC=gcc but no
1057 # other gcc command.
1058 if ($line =~ /(.*)CC=$cc_regex_full(.*)/o) {
1061 next if not $before =~ /$cc_regex_normal/o
1062 and not $after =~ /$cc_regex_normal/o;
1064 # Ignore false positives caused by gcc -v. It outputs a line
1065 # looking like a normal compiler line but which is sometimes
1066 # missing hardening flags, although the normal compiler line
1068 next if $line =~ m{^\s+/usr/lib/gcc/$cc_regex_full_prefix/
1069 [0-9.]+/cc1(?:plus)?}xo;
1070 # Ignore false positive with `rm` which may remove files which
1071 # look like a compiler executable thus causing the line to be
1072 # treated as a normal compiler line.
1073 next if $line =~ m{^\s*rm\s+};
1074 next if $line =~ m{^\s*dwz\s+};
1075 # Some build systems emit "gcc > file".
1076 next if $line =~ m{$cc_regex_normal\s*>\s*\S+}o;
1077 # Hex output may contain "cc".
1078 next if $line =~ m#(?:\b[0-9a-fA-F]{2,}\b\s*){5}#;
1079 # Meson build output
1080 next if $line =~ /^C\+\+ linker for the host machine: /;
1081 # Embedded `gcc -print-*` commands
1082 next if $line =~ /`$cc_regex_normal\s*[^`]*-print-\S+`/;
1084 # Check if additional hardening options were used. Used to ensure
1085 # they are used for the complete build.
1086 $harden_pie = 1 if any_flags_used($line, @def_cflags_pie,
1088 $harden_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
1091 push @input_nonverbose, $non_verbose;
1092 push @input_number, $number if $option_line_numbers;
1096 close $fh or die $!;
1098 # Ignore arch if requested.
1099 if (scalar @option_ignore_arch > 0 and $arch) {
1100 foreach my $ignore (@option_ignore_arch) {
1101 if ($arch eq $ignore) {
1102 print "ignoring architecture '$arch'\n";
1108 if (scalar @input == 0) {
1109 if (not $option_buildd) {
1110 print "No compiler commands!\n";
1111 $exit |= $exit_code{no_compiler_commands};
1113 print "$buildd_tag{no_compiler_commands}||\n";
1118 if ($option_buildd) {
1119 $statistics{commands} += scalar @input;
1122 # Option or auto detected.
1124 # The following was partially copied from dpkg-dev 1.20.5
1125 # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, _add_build_flags()),
1126 # copyright Raphaël Hertzog <hertzog@debian.org>, Guillem Jover
1127 # <guillem@debian.org>, Kees Cook <kees@debian.org>, Canonical, Ltd.
1128 # licensed under GPL version 2 or later. Keep it in sync.
1132 # Recent dpkg versions use a quadruplet for arch. Support both.
1134 (undef, undef, $os, $cpu) = Dpkg::Arch::debarch_to_debtuple($arch);
1137 (undef, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
1140 my %builtin_pie_arch = map { $_ => 1 } qw(
1161 # Disable unsupported hardening options.
1162 if ($os !~ /^(?:linux|kfreebsd|knetbsd|hurd)$/
1163 or $cpu =~ /^(?:hppa|avr32)$/) {
1166 if ($cpu =~ /^(?:ia64|alpha|hppa|nios2)$/ or $arch eq 'arm') {
1168 $harden_stack_strong = 0;
1170 if ($cpu =~ /^(?:ia64|hppa|avr32)$/) {
1172 $harden_bindnow = 0;
1175 if ($disable_harden_pie and exists $builtin_pie_arch{$arch}) {
1181 my @cflags = @def_cflags;
1182 my @cxxflags = @def_cxxflags;
1183 my @cppflags = @def_cppflags;
1184 my @ldflags = @def_ldflags;
1185 # Check the specified hardening options, same order as dpkg-buildflags.
1187 @cflags = (@cflags, @def_cflags_pie);
1188 @cxxflags = (@cxxflags, @def_cflags_pie);
1189 @ldflags = (@ldflags, @def_ldflags_pie);
1191 if ($harden_stack_strong) {
1192 @cflags = (@cflags, @def_cflags_stack_strong);
1193 @cxxflags = (@cxxflags, @def_cflags_stack_strong);
1194 } elsif ($harden_stack) {
1195 @cflags = (@cflags, @def_cflags_stack);
1196 @cxxflags = (@cxxflags, @def_cflags_stack);
1198 if ($harden_fortify) {
1199 @cflags = (@cflags, @def_cflags_fortify);
1200 @cxxflags = (@cxxflags, @def_cflags_fortify);
1201 @cppflags = (@cppflags, @def_cppflags_fortify);
1203 if ($harden_format) {
1204 @cflags = (@cflags, @def_cflags_format);
1205 @cxxflags = (@cxxflags, @def_cflags_format);
1207 if ($harden_relro) {
1208 @ldflags = (@ldflags, @def_ldflags_relro);
1210 if ($harden_bindnow) {
1211 @ldflags = (@ldflags, @def_ldflags_bindnow);
1214 # Ada doesn't support format hardening flags, see #680117 for more
1215 # information. Same for fortran.
1217 my @cflags_noformat = grep {
1219 foreach my $flag (@def_cflags_format) {
1220 $ok = 0 if $_ eq $flag;
1225 # Hack to fix cppflags_fortify_broken() if --ignore-flag
1226 # -D_FORTIFY_SOURCE=2 is used to ignore missing fortification. Only works
1227 # as long as @def_cppflags_fortify contains only one variable.
1228 if (scalar @def_cppflags_fortify == 0) {
1229 $harden_fortify = 0;
1232 # Ignore flags for this arch if requested.
1233 if ($arch and exists $option_ignore_arch_flag{$arch}) {
1234 my @local_flag_refs = (\@cflags, \@cxxflags, \@cppflags, \@ldflags);
1236 remove_flags(\@local_flag_refs,
1238 @{$option_ignore_arch_flag{$arch}});
1241 my @ignore_line = @option_ignore_line;
1242 # Ignore lines for this arch if requested.
1243 if ($arch and exists $option_ignore_arch_line{$arch}) {
1244 @ignore_line = (@ignore_line, @{$option_ignore_arch_line{$arch}});
1248 for (my $i = 0; $i < scalar @input; $i++) {
1249 my $line = $input[$i];
1251 # Ignore line if requested.
1252 foreach my $ignore (@ignore_line) {
1253 next LINE if $line =~ /$ignore/;
1257 if ($input_nonverbose[$i]
1258 and is_non_verbose_build($line, \$skip,
1259 \@input, $i, $parallel)) {
1260 if (not $option_buildd) {
1261 error_non_verbose_build($line, $input_number[$i]);
1262 $exit |= $exit_code{non_verbose_build};
1264 $statistics{commands_nonverbose}++;
1268 # Even if it's a verbose build, we might have to skip this line (see
1269 # is_non_verbose_build()).
1272 my $orig_line = $line;
1274 # Remove everything until and including the compiler command. Makes
1275 # checks easier and faster.
1276 $line =~ s/^.*?$cc_regex//o;
1277 # "([...] test.c)" is not detected as 'test.c' - fix this by removing
1278 # the brace and similar characters at the line end.
1279 $line =~ s/['")]+$//;
1281 # Skip unnecessary tests when only preprocessing.
1282 my $flag_preprocess = 0;
1289 # Preprocess, compile, assemble.
1290 if ($line =~ /\s(-E|-S|-c)\b/) {
1292 $flag_preprocess = 1 if $1 eq '-E';
1293 $compile = 1 if $1 eq '-S' or $1 eq '-c';
1294 # Dependency generation for Makefiles. The other flags (-MF -MG -MP
1295 # -MT -MQ) are always used with -M/-MM.
1296 } elsif ($line =~ /\s(?:-M|-MM)\b/) {
1298 # Otherwise assume we are linking.
1303 # -MD/-MMD also cause dependency generation, but they don't imply -E!
1304 if ($line =~ /\s(?:-MD|-MMD)\b/) {
1306 $flag_preprocess = 0;
1309 # Dependency generation for Makefiles, no preprocessing or other flags
1311 next if $dependency;
1313 # Get all file extensions on this line.
1314 my @extensions = $line =~ /$file_extension_regex/go;
1315 # Ignore all unknown extensions to speedup the search below.
1316 @extensions = grep { exists $extension{$_} } @extensions;
1318 # These file types don't require preprocessing.
1319 if (extension_found(\%extensions_no_preprocess, @extensions)) {
1322 # These file types require preprocessing.
1323 if (extension_found(\%extensions_preprocess, @extensions)) {
1324 # Prevent false positives with "libtool: link: g++ -include test.h
1325 # .." compiler lines.
1326 if ($orig_line !~ /$libtool_link_regex/o) {
1331 if (not $flag_preprocess) {
1332 # If there are source files then it's compiling/linking in one
1333 # step and we must check both. We only check for source files
1334 # here, because header files cause too many false positives.
1335 if (extension_found(\%extensions_compile_link, @extensions)) {
1336 # Assembly files don't need CFLAGS.
1337 if (not extension_found(\%extensions_compile, @extensions)
1338 and extension_found(\%extensions_no_compile, @extensions)) {
1340 # But the rest does.
1344 # No compilable extensions found, either linking or compiling
1347 # If there are also no object files we are just compiling headers
1348 # (.h -> .h.gch). Don't check for linker flags in this case. Due
1349 # to our liberal checks for compiler lines, this also reduces the
1350 # number of false positives considerably.
1352 and not extension_found(\%extensions_object, @extensions)) {
1357 my $compile_cpp = 0;
1358 my $restore_cflags = 0;
1359 # Assume CXXFLAGS are required when a C++ file is specified in the
1362 and extension_found(\%extensions_compile_cpp, @extensions)) {
1365 # Ada needs special CFLAGS
1366 } elsif (extension_found(\%extensions_ada, @extensions)) {
1367 $restore_cflags = 1;
1368 $preprocess = 0; # Ada uses no CPPFLAGS
1369 @cflags_backup = @cflags;
1370 @cflags = @cflags_noformat;
1372 } elsif (extension_found(\%extensions_fortran, @extensions)) {
1373 $restore_cflags = 1;
1374 @cflags_backup = @cflags;
1375 @cflags = @cflags_noformat;
1378 if ($option_buildd) {
1379 $statistics{preprocess}++ if $preprocess;
1380 $statistics{compile}++ if $compile;
1381 $statistics{compile_cpp}++ if $compile_cpp;
1382 $statistics{link}++ if $link;
1385 # Check if there are flags indicating a debug build. If that's true,
1386 # skip the check for -O2. This prevents fortification, but that's fine
1387 # for a debug build.
1388 if (any_flags_used($line, @def_cflags_debug)) {
1389 remove_flags([\@cflags], \%flag_renames, $def_cflags[1]);
1390 remove_flags([\@cppflags], \%flag_renames, $def_cppflags_fortify[0]);
1393 # Check hardening flags.
1395 if ($compile and (not all_flags_used($line, \@missing, @cflags)
1396 or (($harden_stack or $harden_stack_strong)
1397 and cflags_stack_broken($line, \@missing,
1398 $harden_stack_strong)))
1399 # Libraries linked with -fPIC don't have to (and can't) be
1400 # linked with -fPIE as well. It's no error if only PIE flags
1402 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1403 # Assume dpkg-buildflags returns the correct flags.
1404 and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
1405 if (not $option_buildd) {
1406 error_flags('CFLAGS missing', \@missing, \%flag_renames,
1407 $input[$i], $input_number[$i]);
1408 $exit |= $exit_code{flags_missing};
1410 $statistics{compile_missing}++;
1412 } elsif ($compile_cpp and not all_flags_used($line, \@missing, @cflags)
1413 # Libraries linked with -fPIC don't have to (and can't) be
1414 # linked with -fPIE as well. It's no error if only PIE flags
1416 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1417 # Assume dpkg-buildflags returns the correct flags.
1418 and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
1419 if (not $option_buildd) {
1420 error_flags('CXXFLAGS missing', \@missing, \%flag_renames,
1421 $input[$i], $input_number[$i]);
1422 $exit |= $exit_code{flags_missing};
1424 $statistics{compile_cpp_missing}++;
1428 and (not all_flags_used($line, \@missing, @cppflags)
1429 # The fortify flag might be overwritten, detect that.
1431 and cppflags_fortify_broken($line, \@missing)))
1432 # Assume dpkg-buildflags returns the correct flags.
1433 and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
1434 if (not $option_buildd) {
1435 error_flags('CPPFLAGS missing', \@missing, \%flag_renames,
1436 $input[$i], $input_number[$i]);
1437 $exit |= $exit_code{flags_missing};
1439 $statistics{preprocess_missing}++;
1442 if ($link and not all_flags_used($line, \@missing, @ldflags)
1443 # Same here, -fPIC conflicts with -fPIE.
1444 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie)
1445 # Assume dpkg-buildflags returns the correct flags.
1446 and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
1447 if (not $option_buildd) {
1448 error_flags('LDFLAGS missing', \@missing, \%flag_renames,
1449 $input[$i], $input_number[$i]);
1450 $exit |= $exit_code{flags_missing};
1452 $statistics{link_missing}++;
1456 # Restore normal CFLAGS.
1457 if ($restore_cflags) {
1458 @cflags = @cflags_backup;
1463 # Print statistics for buildd mode, only output in this mode.
1464 if ($option_buildd) {
1467 if ($statistics{preprocess_missing}) {
1468 push @warning, sprintf 'CPPFLAGS %d (of %d)',
1469 $statistics{preprocess_missing},
1470 $statistics{preprocess};
1472 if ($statistics{compile_missing}) {
1473 push @warning, sprintf 'CFLAGS %d (of %d)',
1474 $statistics{compile_missing},
1475 $statistics{compile};
1477 if ($statistics{compile_cpp_missing}) {
1478 push @warning, sprintf 'CXXFLAGS %d (of %d)',
1479 $statistics{compile_cpp_missing},
1480 $statistics{compile_cpp};
1482 if ($statistics{link_missing}) {
1483 push @warning, sprintf 'LDFLAGS %d (of %d)',
1484 $statistics{link_missing},
1487 if (scalar @warning) {
1488 local $" = ', '; # array join string
1489 print "$buildd_tag{flags_missing}|@warning missing|\n";
1492 if ($statistics{commands_nonverbose}) {
1493 printf "$buildd_tag{non_verbose_build}|%d (of %d) hidden|\n",
1494 $statistics{commands_nonverbose},
1495 $statistics{commands},
1507 blhc - build log hardening check, checks build logs for missing hardening flags
1511 B<blhc> [I<options>] I<< <dpkg-buildpackage build log file>.. >>
1515 blhc is a small tool which checks build logs for missing hardening flags. It's
1516 licensed under the GPL 3 or later.
1518 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
1519 tools using dpkg-buildpackage like pbuilder or sbuild (which is used for the
1520 official buildd build logs)) to help maintainers detect missing hardening
1521 flags in their packages.
1523 Only gcc is detected as compiler at the moment. If other compilers support
1524 hardening flags as well, please report them.
1526 If there's no output, no flags are missing and the build log is fine.
1528 See F<README> for details about performed checks, auto-detection and
1531 =head1 FALSE POSITIVES
1533 To suppress false positives you can embed the following string in the build
1536 blhc: ignore-line-regexp: REGEXP
1538 All lines fully matching REGEXP (see B<--ignore-line> for details) will be
1541 Please use this feature sparingly so that missing flags are not overlooked. If
1542 you find false positives which affect more packages please report a bug.
1544 To generate this string simply use echo in C<debian/rules>; make sure to use @
1545 to suppress the echo command itself as it could also trigger a false positive.
1553 Force check for all +all (+pie, +bindnow) hardening flags. By default it's
1556 =item B<--arch> I<architecture>
1558 Set the specific architecture (e.g. amd64, armel, etc.), automatically
1559 disables hardening flags not available on this architecture. Is detected
1560 automatically if dpkg-buildpackage is used.
1564 Force check for all +bindnow hardening flags. By default it's auto detected.
1568 Special mode for buildds when automatically parsing log files. The following
1569 changes are in effect:
1575 Print tags instead of normal warnings, see L</"BUILDD TAGS"> for a list of
1580 Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is
1585 Don't require Term::ANSIColor.
1589 Return exit code 0, unless there was a error (-I, -W messages don't count as
1596 Apply Debian-specific settings. At the moment this only disables checking for
1597 PIE which is automatically applied by Debian's GCC and no longer requires a
1598 compiler command line argument.
1602 Use colored (ANSI) output for warning messages.
1604 =item B<--line-numbers>
1606 Display line numbers.
1608 =item B<--ignore-arch> I<arch>
1610 Ignore build logs from architectures matching I<arch>. I<arch> is a string.
1612 Used to prevent false positives. This option can be specified multiple times.
1614 =item B<--ignore-arch-flag> I<arch>:I<flag>
1616 Like B<--ignore-flag>, but only ignore flag on I<arch>.
1618 =item B<--ignore-arch-line> I<arch>:I<line>
1620 Like B<--ignore-line>, but only ignore line on I<arch>.
1622 =item B<--ignore-flag> I<flag>
1624 Don't print an error when the specific flag is missing in a compiler line.
1625 I<flag> is a string.
1627 Used to prevent false positives. This option can be specified multiple times.
1629 =item B<--ignore-line> I<regex>
1631 Ignore lines matching the given Perl regex. I<regex> is automatically anchored
1632 at the beginning and end of the line to prevent false negatives.
1634 B<NOTE>: Not the input lines are checked, but the lines which are displayed in
1635 warnings (which have line continuation resolved).
1637 Used to prevent false positives. This option can be specified multiple times.
1641 Force check for all +pie hardening flags. By default it's auto detected.
1643 =item B<-h -? --help>
1645 Print available options.
1649 Print version number and license.
1653 Auto detection for B<--pie> and B<--bindnow> only works if at least one
1654 command uses the required hardening flag (e.g. -fPIE). Then it's required for
1655 all other commands as well.
1659 Normal usage, parse a single log file.
1661 blhc path/to/log/file
1663 If there's no output, no flags are missing and the build log is fine.
1665 Parse multiple log files. The exit code is ORed over all files.
1667 blhc path/to/directory/with/log/files/*
1669 Don't treat missing C<-g> as error:
1671 blhc --ignore-flag -g path/to/log/file
1673 Don't treat missing C<-pie> on kfreebsd-amd64 as error:
1675 blhc --ignore-arch-flag kfreebsd-amd64:-pie path/to/log/file
1677 Ignore lines consisting exactly of C<./script gcc file> which would cause a
1680 blhc --ignore-line '\./script gcc file' path/to/log/file
1682 Ignore lines matching C<./script gcc file> somewhere in the line.
1684 blhc --ignore-line '.*\./script gcc file.*' path/to/log/file
1686 Use blhc with pbuilder.
1688 pbuilder path/to/package.dsc | tee path/log/file
1689 blhc path/to/file || echo flags missing
1691 Assume this build log was created on a Debian system and thus don't warn about
1692 missing PIE flags if the current architecture injects them automatically (this
1693 is enabled in buildd mode per default). C<--arch> is necessary if the build
1694 log contains no architecture information as written by dpkg-buildpackage.
1696 blhc --debian --all --arch=amd64 path/to/log/file
1700 The following tags are used in I<--buildd> mode. In braces the additional data
1705 =item B<I-hardening-wrapper-used>
1707 The package uses hardening-wrapper which intercepts calls to gcc and adds
1708 hardening flags. The build log doesn't contain any hardening flags and thus
1709 can't be checked by blhc.
1711 =item B<W-compiler-flags-hidden> (summary of hidden lines)
1713 Build log contains lines which hide the real compiler flags. For example:
1720 Most of the time either C<export V=1> or C<export verbose=1> in
1721 F<debian/rules> fixes builds with hidden compiler flags. Sometimes C<.SILENT>
1722 in a F<Makefile> must be removed. And as last resort the F<Makefile> must be
1723 patched to remove the C<@>s hiding the real compiler commands.
1725 =item B<W-dpkg-buildflags-missing> (summary of missing flags)
1727 CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
1729 =item B<I-invalid-cmake-used> (version)
1731 By default CMake ignores CPPFLAGS thus missing those hardening flags. Debian
1732 patched CMake in versions 2.8.7-1 and 2.8.7-2 to respect CPPFLAGS, but this
1733 patch was rejected by upstream and later reverted in Debian. Thus those two
1734 versions show correct usage of CPPFLAGS even if the package doesn't correctly
1735 handle them (for example by passing them to CFLAGS). To prevent false
1736 negatives just blacklist those two versions.
1738 =item B<I-no-compiler-commands>
1740 No compiler commands were detected. Either the log contains none or they were
1741 not correctly detected by blhc (please report the bug in this case).
1747 The exit status is a "bit mask", each listed status is ORed when the error
1748 condition occurs to get the result.
1758 No compiler commands were found.
1762 Invalid arguments/options given to blhc.
1770 Missing hardening flags.
1774 Hardening wrapper detected, no tests performed.
1778 Invalid CMake version used. See B<I-invalid-cmake-used> under L</"BUILDD
1779 TAGS"> for a detailed explanation.
1785 Simon Ruderich, E<lt>simon@ruderich.orgE<gt>
1787 Thanks to to Bernhard R. Link E<lt>brlink@debian.orgE<gt> and Jaria Alto
1788 E<lt>jari.aalto@cante.netE<gt> for their valuable input and suggestions.
1790 =head1 LICENSE AND COPYRIGHT
1792 Copyright (C) 2012-2020 by Simon Ruderich
1794 This program is free software: you can redistribute it and/or modify
1795 it under the terms of the GNU General Public License as published by
1796 the Free Software Foundation, either version 3 of the License, or
1797 (at your option) any later version.
1799 This program is distributed in the hope that it will be useful,
1800 but WITHOUT ANY WARRANTY; without even the implied warranty of
1801 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1802 GNU General Public License for more details.
1804 You should have received a copy of the GNU General Public License
1805 along with this program. If not, see <http://www.gnu.org/licenses/>.
1809 L<hardening-check(1)>, L<dpkg-buildflags(1)>