3 # Build log hardening check, checks build logs for missing hardening flags.
5 # Copyright (C) 2012-2023 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.13';
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=[23]', # 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().
300 '-O(?:2|3)' => '-O2',
301 '-Wformat(?:=2)?' => '-Wformat',
302 '--param[= ]ssp-buffer-size=4' => '--param=ssp-buffer-size=4',
303 '-D_FORTIFY_SOURCE=[23]' => '-D_FORTIFY_SOURCE=2',
304 '-Wl,(?:-z,)?relro' => '-Wl,-z,relro',
305 '-Wl,(?:-z,)?now' => '-Wl,-z,now',
309 no_compiler_commands => 1 << 0,
310 # used by POD::Usage => 1 << 1,
311 non_verbose_build => 1 << 2,
312 flags_missing => 1 << 3,
313 hardening_wrapper => 1 << 4,
314 invalid_cmake => 1 << 5,
318 no_compiler_commands => 'I-no-compiler-commands',
319 non_verbose_build => 'W-compiler-flags-hidden',
320 flags_missing => 'W-dpkg-buildflags-missing',
321 hardening_wrapper => 'I-hardening-wrapper-used',
322 invalid_cmake => 'I-invalid-cmake-used',
325 # Statistics of missing flags and non-verbose build commands. Used for
329 preprocess_missing => 0,
331 compile_missing => 0,
333 compile_cpp_missing => 0,
337 commands_nonverbose => 0,
340 # Use colored (ANSI) output?
350 foreach my $delim (';', '&&', '||') {
353 push @x, Text::ParseWords::parse_line(qr/\Q$delim\E/, 1, $_);
359 # Ensure newline at the line end - necessary for
360 # correct parsing later.
367 my ($message, $missing_flags_ref, $flag_renames_ref, $line, $number) = @_;
369 # Get string value of qr//-escaped regexps and if requested rename them.
370 my @missing_flags = map {
371 $flag_renames_ref->{$_}
372 } @{$missing_flags_ref};
374 my $flags = join ' ', @missing_flags;
375 printf '%d:', $number if defined $number;
376 printf '%s (%s)%s %s',
377 error_color($message, 'red'), $flags, error_color(':', 'yellow'),
382 sub error_non_verbose_build {
383 my ($line, $number) = @_;
385 printf '%d:', $number if defined $number;
387 error_color('NONVERBOSE BUILD', 'red'),
388 error_color(':', 'yellow'),
393 sub error_invalid_cmake {
397 error_color('INVALID CMAKE', 'red'),
398 error_color(':', 'yellow'),
403 sub error_hardening_wrapper {
405 error_color('HARDENING WRAPPER', 'red'),
406 error_color(':', 'yellow'),
407 'no checks possible, aborting';
412 my ($message, $color) = @_;
415 return Term::ANSIColor::colored($message, $color);
422 my ($line, @flags) = @_;
424 foreach my $flag (@flags) {
425 return 1 if $line =~ /$flag/;
431 my ($line, $missing_flags_ref, @flags) = @_;
433 my @missing_flags = ();
434 foreach my $flag (@flags) {
435 if (not $line =~ /$flag/) {
436 push @missing_flags, $flag;
440 return 1 if scalar @missing_flags == 0;
442 @{$missing_flags_ref} = @missing_flags;
445 # Check if any of \@bad_flags occurs after $good_flag. Doesn't check if
446 # $good_flag is present.
447 sub flag_overwritten {
448 my ($line, $good_flag, $bad_flags) = @_;
450 if (not any_flags_used($line, @{$bad_flags})) {
455 foreach my $flag (@{$bad_flags}) {
456 while ($line =~ /$flag/g) {
457 if ($bad_pos < $+[0]) {
463 while ($line =~ /$good_flag/g) {
466 if ($good_pos > $bad_pos) {
472 sub cppflags_fortify_broken {
473 my ($line, $missing_flags) = @_;
475 # $def_cppflags_fortify[0] must be -D_FORTIFY_SOURCE=2!
476 my $fortify_source = $def_cppflags_fortify[0];
478 # Some build systems enable/disable fortify source multiple times, check
480 if (not flag_overwritten($line,
482 \@def_cppflags_fortify_bad)) {
485 push @{$missing_flags}, $fortify_source;
489 sub cflags_stack_broken {
490 my ($line, $missing_flags, $strong) = @_;
492 my $flag = $strong ? $def_cflags_stack_strong[0]
493 : $def_cflags_stack[0];
495 if (not flag_overwritten($line, $flag, \@def_cflags_stack_bad)) {
498 push @{$missing_flags}, $flag;
502 # Modifies $missing_flags_ref array.
503 sub pic_pie_conflict {
504 my ($line, $pie, $missing_flags_ref, @flags_pie) = @_;
506 return 0 if not $pie;
507 return 0 if not any_flags_used($line, @def_ldflags_pic);
509 my %flags = map { $_ => 1 } @flags_pie;
511 # Remove all PIE flags from @missing_flags as they are not required with
514 not exists $flags{$_}
515 } @{$missing_flags_ref};
516 @{$missing_flags_ref} = @result;
518 # We got a conflict when no flags are left, thus only PIE flags were
519 # missing. If other flags were missing abort because the conflict is not
521 return scalar @result == 0;
524 sub is_non_verbose_build {
525 my ($line, $skip_ref, $input_ref, $line_offset, $line_count) = @_;
527 if ($line =~ /$libtool_regex/o) {
528 # libtool's --silent hides the real compiler flags.
529 if ($line =~ /\s--silent/) {
531 # If --silent is not present, skip this line as some compiler flags
532 # might be missing (e.g. -fPIE) which are handled correctly by libtool
533 # internally. libtool displays the real compiler command on the next
534 # line, so the flags are checked as usual.
541 if (not (index($line, 'checking if you want to see long compiling messages... no') == 0
542 or $line =~ /^\s*\[?(?:CC|CCLD|C\+\+|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/
543 or $line =~ /^\s*[][\/0-9 ]*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
544 or $line =~ /^\s*[Bb]uilding (?:program|shared library)\s+(.+?)$/
545 or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
551 # C++ compiler setting.
552 return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
553 return 0 if $line =~ /^\s*C\+\+ Library: stdc\+\+$/;
554 # "Compiling" non binary files.
555 return 0 if $line =~ /^\s*Compiling \S+\.(?:py|pyx|el)['"]?\s*(?:\.\.\.|because it changed\.)?$/;
556 return 0 if $line =~ /^\s*[Cc]ompiling catalog \S+\.po\b/;
557 # "Compiling" with no file name.
558 if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) {
559 # $file_extension_regex may need spaces around the filename.
560 return 0 if not " $1 " =~ /$file_extension_regex/o;
565 # On the first pass we only check if this line is verbose or not.
566 return 1 if not defined $input_ref;
568 # Second pass, we have access to the next lines.
571 # CMake and other build systems print the non-verbose messages also when
572 # building verbose. If a compiler and the file name occurs in the next
573 # lines, treat it as verbose build.
575 # Get filename, we can't use the complete path as only parts of it are
576 # used in the real compiler command.
577 $file =~ m{/([^/\s]+)$};
580 for (my $i = 1; $i <= $line_count; $i++) {
581 my $next_line = $input_ref->[$line_offset + $i];
582 last unless defined $next_line;
584 if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
585 # Not a non-verbose line, but we still have to skip the
586 # current line as it doesn't contain any compiler commands.
596 # Remove @flags from $flag_refs_ref, uses $flag_renames_ref as reference.
598 my ($flag_refs_ref, $flag_renames_ref, @flags) = @_;
600 my %removes = map { $_ => 1 } @flags;
601 foreach my $flags (@{$flag_refs_ref}) {
603 # Flag found as string.
604 not exists $removes{$_}
605 # Flag found as string representation of regexp.
606 and (not defined $flag_renames_ref->{$_}
607 or not exists $removes{$flag_renames_ref->{$_}})
614 # Modifies $flag_renames_ref hash.
615 sub compile_flag_regexp {
616 my ($flag_renames_ref, @flags) = @_;
619 foreach my $flag (@flags) {
620 # Compile flag regexp for faster execution.
621 my $regex = qr/\s(['"]?)$flag\1(?:\s|\\)/;
623 # Store flag name in replacement string for correct flags in messages
624 # with qr//ed flag regexps.
625 $flag_renames_ref->{$regex}
626 = (exists $flag_renames_ref->{$flag})
627 ? $flag_renames_ref->{$flag}
630 push @result, $regex;
635 # Does any extension in @extensions exist in %{$extensions_ref}?
636 sub extension_found {
637 my ($extensions_ref, @extensions) = @_;
639 foreach my $extension (@extensions) {
640 if (exists $extensions_ref->{$extension}) {
650 # Parse command line arguments.
652 my $option_version = 0;
654 my $option_bindnow = 0;
655 my @option_ignore_arch = ();
656 my @option_ignore_flag = ();
657 my @option_ignore_arch_flag = ();
658 my @option_ignore_line = ();
659 my @option_ignore_arch_line = ();
661 my $option_arch = undef;
662 my $option_buildd = 0;
663 my $option_debian = 0;
665 my $option_line_numbers = 0;
666 if (not Getopt::Long::GetOptions(
667 'help|h|?' => \$option_help,
668 'version' => \$option_version,
670 'pie' => \$option_pie,
671 'bindnow' => \$option_bindnow,
672 'all' => \$option_all,
674 'ignore-arch=s' => \@option_ignore_arch,
675 'ignore-flag=s' => \@option_ignore_flag,
676 'ignore-arch-flag=s' => \@option_ignore_arch_flag,
677 'ignore-line=s' => \@option_ignore_line,
678 'ignore-arch-line=s' => \@option_ignore_arch_line,
680 'color' => \$option_color,
681 'arch=s' => \$option_arch,
682 'buildd' => \$option_buildd,
683 'debian' => \$option_debian,
684 'line-numbers' => \$option_line_numbers,
687 Pod::Usage::pod2usage(2);
691 Pod::Usage::pod2usage(1);
693 if ($option_version) {
695 blhc $VERSION Copyright (C) 2012-2023 Simon Ruderich
697 This program is free software: you can redistribute it and/or modify
698 it under the terms of the GNU General Public License as published by
699 the Free Software Foundation, either version 3 of the License, or
700 (at your option) any later version.
702 This program is distributed in the hope that it will be useful,
703 but WITHOUT ANY WARRANTY; without even the implied warranty of
704 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
705 GNU General Public License for more details.
707 You should have received a copy of the GNU General Public License
708 along with this program. If not, see <http://www.gnu.org/licenses/>.
714 if (scalar @ARGV == 0) {
716 Pod::Usage::pod2usage(2);
719 # Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not
720 # installed on Debian's buildds.
721 if (not $option_buildd) {
722 require Term::ANSIColor;
730 # Precompiled ignores for faster lookup.
731 my %option_ignore_arch_flag = ();
732 my %option_ignore_arch_line = ();
734 # Strip flags which should be ignored.
735 if (scalar @option_ignore_flag > 0) {
736 remove_flags(\@flag_refs, \%flag_renames, @option_ignore_flag);
738 # Same for arch specific ignore flags, but only prepare here.
739 if (scalar @option_ignore_arch_flag > 0) {
740 foreach my $ignore (@option_ignore_arch_flag) {
741 my ($ignore_arch, $ignore_flag) = split /:/, $ignore, 2;
743 if (not $ignore_arch or not $ignore_flag) {
744 printf STDERR 'Value "%s" invalid for option ignore-arch-flag '
745 . '("arch:flag" expected)' . "\n", $ignore;
747 Pod::Usage::pod2usage(2);
750 push @{$option_ignore_arch_flag{$ignore_arch}}, $ignore_flag;
754 # Precompile all flag regexps. any_flags_used(), all_flags_used() get a lot
756 foreach my $flags (@flag_refs_all) {
757 @{$flags} = compile_flag_regexp(\%flag_renames, @{$flags});
760 # Precompile ignore line regexps, also anchor at beginning and end of line.
761 # Additional entries are also extracted from the build log, see below.
762 foreach my $ignore (@option_ignore_line) {
763 $ignore = qr/^$ignore$/;
765 # Same for arch specific ignore lines.
766 if (scalar @option_ignore_arch_line > 0) {
767 foreach my $ignore (@option_ignore_arch_line) {
768 my ($ignore_arch, $ignore_line) = split /:/, $ignore, 2;
770 if (not $ignore_arch or not $ignore_line) {
771 printf STDERR 'Value "%s" invalid for option ignore-arch-line '
772 . '("arch:line" expected)' . "\n", $ignore;
774 Pod::Usage::pod2usage(2);
777 push @{$option_ignore_arch_line{$ignore_arch}}, qr/^$ignore_line$/;
785 foreach my $file (@ARGV) {
786 print "checking '$file'...\n" if scalar @ARGV > 1;
788 -f $file or die "No such file: $file";
790 open my $fh, '<', $file or die $!;
792 # Architecture of this file.
793 my $arch = $option_arch;
795 # Hardening options. Not all architectures support all hardening options.
796 my $harden_format = 1;
797 my $harden_fortify = 1;
798 my $harden_stack = 1;
799 my $harden_stack_strong = 1;
800 my $harden_relro = 1;
801 my $harden_bindnow = $option_bindnow; # defaults to 0
802 my $harden_pie = $option_pie; # defaults to 0
804 # Number of parallel jobs to prevent false positives when detecting
805 # non-verbose builds. As not all jobs declare the number of parallel jobs
806 # use a large enough default.
809 # Don't check for PIE flags if automatically applied by the compiler. Only
810 # used in buildd and Debian mode.
811 my $disable_harden_pie = 0;
812 if ($option_debian) {
813 $disable_harden_pie = 1;
817 while (my $line = <$fh>) {
820 # Detect architecture automatically unless overridden. For buildd logs
821 # only, doesn't use the dpkg-buildpackage header. Necessary to ignore
822 # build logs which aren't built (wrong architecture, build error,
825 if (index($line, 'Build Architecture: ') == 0) {
826 $arch = substr $line, 20, -1; # -1 to ignore '\n' at the end
827 # For old logs (sbuild << 0.63.0-1).
828 } elsif (index($line, 'Architecture: ') == 0) {
829 $arch = substr $line, 14, -1; # -1 to ignore '\n' at the end
833 # dpkg-buildflags only provides hardening flags since 1.16.1, don't
834 # check for hardening flags in buildd mode if an older dpkg-dev is
835 # used. Default flags (-g -O2) are still checked.
837 # Packages which were built before 1.16.1 but used their own hardening
838 # flags are not checked.
840 # Strong stack protector is used since dpkg 1.17.11.
842 # Recent GCC versions automatically use PIE (only on supported
843 # architectures) and dpkg respects this properly since 1.18.15 and
844 # doesn't pass PIE flags manually.
846 and index($line, 'Toolchain package versions: ') == 0) {
847 require Dpkg::Version;
850 my $disable_strong = 1;
852 if ($line =~ /\bdpkg-dev_(\S+)/) {
853 if (Dpkg::Version::version_compare($1, '1.16.1') >= 0) {
856 if (Dpkg::Version::version_compare($1, '1.17.11') >= 0) {
859 if (Dpkg::Version::version_compare($1, '1.18.15') >= 0) {
860 $disable_harden_pie = 1;
872 if ($disable_strong) {
873 $harden_stack_strong = 0;
877 # The following two versions of CMake in Debian obeyed CPPFLAGS, but
878 # this was later dropped because upstream rejected the patch. Thus
879 # build logs with these versions will have fortify hardening flags
880 # enabled, even though they may be not correctly set and are missing
881 # when build with later CMake versions. Thanks to Aron Xu for letting
883 if (index($line, 'Package versions: ') == 0
884 and $line =~ /\bcmake_(\S+)/
885 and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
886 if (not $option_buildd) {
887 error_invalid_cmake($1);
888 $exit |= $exit_code{invalid_cmake};
890 print "$buildd_tag{invalid_cmake}|$1|\n";
894 # Debian's build daemons use "Filtered Build-Depends:" (or just
895 # "Build-Depends:" in older versions) for the build dependencies, but
896 # pbuilder uses "Depends:"; support both.
897 if (index($line, 'Filtered Build-Depends: ') == 0
898 or index($line, 'Build-Depends: ') == 0
899 or index($line, 'Depends: ') == 0) {
900 # If hardening wrapper is used (wraps calls to gcc and adds
901 # hardening flags automatically) we can't perform any checks,
903 if ($line =~ /\bhardening-wrapper\b/) {
904 if (not $option_buildd) {
905 error_hardening_wrapper();
906 $exit |= $exit_code{hardening_wrapper};
908 print "$buildd_tag{hardening_wrapper}||\n";
914 # This flags is not always available, but if it is use it.
915 if ($line =~ /^DEB_BUILD_OPTIONS=.*\bparallel=(\d+)/) {
919 # We skip over unimportant lines at the beginning of the log to
920 # prevent false positives.
921 last if index($line, 'dpkg-buildpackage: ') == 0;
924 # Input lines, contain only the lines with compiler commands.
926 # Non-verbose lines in the input. Used to reduce calls to
927 # is_non_verbose_build() (which is quite slow) in the second loop when
928 # it's already clear if a line is non-verbose or not.
929 my @input_nonverbose = ();
931 my @input_number = ();
933 my $continuation = 0;
934 my $complete_line = undef;
936 while (my $line = <$fh>) {
939 # And stop at the end of the build log. Package details (reported by
940 # the buildd logs) are not important for us. This also prevents false
942 last if index($line, 'Build finished at ') == 0
943 and $line =~ /^Build finished at \d{8}-\d{4}$/;
945 if (not $continuation) {
949 # Detect architecture automatically unless overridden.
951 and index($line, 'dpkg-buildpackage: info: host architecture ') == 0) {
952 $arch = substr $line, 43, -1; # -1 to ignore '\n' at the end
953 # Older versions of dpkg-buildpackage
955 and index($line, 'dpkg-buildpackage: host architecture ') == 0) {
956 $arch = substr $line, 37, -1; # -1 to ignore '\n' at the end
958 # Old buildd logs use e.g. "host architecture is alpha", remove
959 # the "is", otherwise debarch_to_debtriplet() will not detect the
961 if (index($arch, 'is ') == 0) {
962 $arch = substr $arch, 3;
966 # Permit dynamic excludes from within the build log to ignore false
967 # positives. Cannot use a separate config file as we often only have
968 # the build log itself.
969 if (index($line, 'blhc: ignore-line-regexp: ') == 0) {
970 my $ignore = substr $line, 26, -1; # -1 to ignore '\n' at the end
971 push @option_ignore_line, qr/^$ignore$/;
975 next if $line =~ /^\s*#/;
976 # Ignore compiler warnings for now.
977 next if $line =~ /$warning_regex/o;
979 if (not $option_buildd and index($line, "\033") != -1) { # \033 = esc
980 # Remove all ANSI color sequences which are sometimes used in
981 # non-verbose builds.
982 $line = Term::ANSIColor::colorstrip($line);
983 # Also strip '\0xf' (delete previous character), used by Elinks'
986 # And "ESC(B" which seems to be used on armhf and hurd (not sure
988 $line =~ s/\033\(B//g;
991 # Check if this line indicates a non verbose build.
993 $non_verbose |= is_non_verbose_build($line, \$skip);
996 # Treat each command as a single line so we don't ignore valid
997 # commands when handling false positives. split_line() is slow, only
998 # use it when necessary.
999 my @line = ($line !~ /(?:;|&&|\|\|)/)
1001 : split_line($line);
1002 foreach my $line (@line) {
1003 if ($continuation) {
1006 # Join lines, but leave the "\" in place so it's clear where
1007 # the original line break was.
1008 chomp $complete_line;
1009 $complete_line .= ' ' . $line;
1011 # Line continuation, line ends with "\".
1012 if ($line =~ /\\$/) {
1014 # Start line continuation.
1015 if (not defined $complete_line) {
1016 $complete_line = $line;
1021 # Use the complete line if a line continuation occurred.
1022 if (defined $complete_line) {
1023 $line = $complete_line;
1024 $complete_line = undef;
1028 # Strip (basic) environment variables for compiler detection. This
1029 # prevents false positives when environment variables contain
1030 # compiler binaries. Nested quotes, command substitution, etc. is
1035 [a-zA-Z_]+ # environment variable name
1038 [^\s"'\$`\\]+ # non-quoted string
1040 '[^"'\$`\\]*' # single-quoted string
1042 "[^"'\$`\\]*" # double-quoted string
1047 # Ignore lines with no compiler commands.
1048 next if not $non_verbose
1049 and not $noenv =~ /$cc_regex_normal/o;
1050 # Ignore lines with no filenames with extensions. May miss some
1051 # non-verbose builds (e.g. "gcc -o test" [sic!]), but shouldn't be
1052 # a problem as the log will most likely contain other non-verbose
1053 # commands which are detected.
1054 next if not $non_verbose
1055 and not $line =~ /$file_extension_regex/o;
1057 # Ignore false positives.
1059 # `./configure` output.
1060 next if not $non_verbose
1061 and $line =~ /^(?:checking|[Cc]onfigure:) /;
1062 next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
1063 [Cc]ompiler[\s.]*:?\s+
1065 next if $line =~ m{^\s*(?:-\s)?(?:HOST_)?(?:CC|CXX)
1066 \s*=\s*$cc_regex_full
1067 # optional compiler options, don't allow
1068 # "everything" here to prevent false negatives
1069 \s*(?:\s-\S+)*\s*$}xo;
1070 # `echo` is never a compiler command
1071 next if $line =~ /^\s*echo\s/;
1072 # Ignore calls to `make` because they can contain environment
1073 # variables which look like compiler commands, e.g. CC=).
1074 next if $line =~ /^\s*make\s/;
1075 # `moc-qt4`/`moc-qt5` contain '-I.../linux-g++' in their command
1076 # line (or similar for other architectures) which gets recognized
1077 # as a compiler line, but `moc-qt*` is only a preprocessor for Qt
1078 # C++ files. No hardening flags are relevant during this step,
1079 # thus ignore `moc-qt*` lines. The resulting files will be
1080 # compiled in a separate step (and therefore checked).
1081 next if $line =~ m{^\S+(?:/bin/moc(?:-qt[45])?|/lib/qt6/libexec/moc)
1083 -I\S+/mkspecs/[a-z]+-g\++(?:-64)?
1085 # nvcc is not a regular C compiler
1086 next if $line =~ m{^\S+/bin/nvcc\s};
1087 # Ignore false positives when the line contains only CC=gcc but no
1088 # other gcc command.
1089 if ($line =~ /(.*)CC=$cc_regex_full(.*)/o) {
1092 next if not $before =~ /$cc_regex_normal/o
1093 and not $after =~ /$cc_regex_normal/o;
1095 # Ignore false positives caused by gcc -v. It outputs a line
1096 # looking like a normal compiler line but which is sometimes
1097 # missing hardening flags, although the normal compiler line
1099 next if $line =~ m{^\s+/usr/lib/gcc/$cc_regex_full_prefix/
1100 [0-9.]+/cc1(?:plus)?}xo;
1101 # Ignore false positive with `rm` which may remove files which
1102 # look like a compiler executable thus causing the line to be
1103 # treated as a normal compiler line.
1104 next if $line =~ m{^\s*rm\s+};
1105 next if $line =~ m{^\s*dwz\s+};
1106 # Some build systems emit "gcc > file".
1107 next if $line =~ m{$cc_regex_normal\s*>\s*\S+}o;
1108 # Hex output may contain "cc".
1109 next if $line =~ m#(?:\b[0-9a-fA-F]{2,}\b\s*){5}#;
1110 # Meson build output
1111 next if $line =~ /^C\+\+ linker for the host machine: /;
1112 # Embedded `gcc -print-*` commands
1113 next if $line =~ /`$cc_regex_normal\s*[^`]*-print-\S+`/;
1114 # cmake checking for compiler flags without setting CPPFLAGS
1115 next if $line =~ m{^\s*/usr/(bin|lib)/(ccache/)?c\+\+ -dM -E -c /usr/share/cmake-\S+/Modules/CMakeCXXCompilerABI\.cpp};
1117 # Check if additional hardening options were used. Used to ensure
1118 # they are used for the complete build.
1119 $harden_pie = 1 if any_flags_used($line, @def_cflags_pie,
1121 $harden_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
1124 push @input_nonverbose, $non_verbose;
1125 push @input_number, $number if $option_line_numbers;
1129 close $fh or die $!;
1131 # Ignore arch if requested.
1132 if (scalar @option_ignore_arch > 0 and $arch) {
1133 foreach my $ignore (@option_ignore_arch) {
1134 if ($arch eq $ignore) {
1135 print "ignoring architecture '$arch'\n";
1141 if (scalar @input == 0) {
1142 if (not $option_buildd) {
1143 print "No compiler commands!\n";
1144 $exit |= $exit_code{no_compiler_commands};
1146 print "$buildd_tag{no_compiler_commands}||\n";
1151 if ($option_buildd) {
1152 $statistics{commands} += scalar @input;
1155 # Option or auto detected.
1157 # The following was partially copied from dpkg-dev 1.22.0
1158 # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, set_build_features and
1159 # _add_build_flags()), copyright Raphaël Hertzog <hertzog@debian.org>,
1160 # Guillem Jover <guillem@debian.org>, Kees Cook <kees@debian.org>,
1161 # Canonical, Ltd. licensed under GPL version 2 or later. Keep it in
1166 # Recent dpkg versions use a quadruplet for arch. Support both.
1168 (undef, undef, $os, $cpu) = Dpkg::Arch::debarch_to_debtuple($arch);
1171 (undef, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
1174 my %builtin_pie_arch = map { $_ => 1 } qw(
1205 # Disable unsupported hardening options.
1206 if ($os !~ /^(?:linux|kfreebsd|knetbsd|hurd)$/ or $cpu eq 'hppa') {
1209 if ($cpu =~ /^(?:ia64|alpha|hppa|nios2)$/ or $arch eq 'arm') {
1211 $harden_stack_strong = 0;
1213 if ($cpu =~ /^(?:ia64|hppa)$/) {
1215 $harden_bindnow = 0;
1218 if ($disable_harden_pie and exists $builtin_pie_arch{$arch}) {
1224 my @cflags = @def_cflags;
1225 my @cxxflags = @def_cxxflags;
1226 my @cppflags = @def_cppflags;
1227 my @ldflags = @def_ldflags;
1228 # Check the specified hardening options, same order as dpkg-buildflags.
1230 @cflags = (@cflags, @def_cflags_pie);
1231 @cxxflags = (@cxxflags, @def_cflags_pie);
1232 @ldflags = (@ldflags, @def_ldflags_pie);
1234 if ($harden_stack_strong) {
1235 @cflags = (@cflags, @def_cflags_stack_strong);
1236 @cxxflags = (@cxxflags, @def_cflags_stack_strong);
1237 } elsif ($harden_stack) {
1238 @cflags = (@cflags, @def_cflags_stack);
1239 @cxxflags = (@cxxflags, @def_cflags_stack);
1241 if ($harden_fortify) {
1242 @cflags = (@cflags, @def_cflags_fortify);
1243 @cxxflags = (@cxxflags, @def_cflags_fortify);
1244 @cppflags = (@cppflags, @def_cppflags_fortify);
1246 if ($harden_format) {
1247 @cflags = (@cflags, @def_cflags_format);
1248 @cxxflags = (@cxxflags, @def_cflags_format);
1250 if ($harden_relro) {
1251 @ldflags = (@ldflags, @def_ldflags_relro);
1253 if ($harden_bindnow) {
1254 @ldflags = (@ldflags, @def_ldflags_bindnow);
1257 # Ada doesn't support format hardening flags, see #680117 for more
1258 # information. Same for fortran.
1260 my @cflags_noformat = grep {
1262 foreach my $flag (@def_cflags_format) {
1263 $ok = 0 if $_ eq $flag;
1268 # Hack to fix cppflags_fortify_broken() if --ignore-flag
1269 # -D_FORTIFY_SOURCE=2 is used to ignore missing fortification. Only works
1270 # as long as @def_cppflags_fortify contains only one variable.
1271 if (scalar @def_cppflags_fortify == 0) {
1272 $harden_fortify = 0;
1275 # Ignore flags for this arch if requested.
1276 if ($arch and exists $option_ignore_arch_flag{$arch}) {
1277 my @local_flag_refs = (\@cflags, \@cxxflags, \@cppflags, \@ldflags);
1279 remove_flags(\@local_flag_refs,
1281 @{$option_ignore_arch_flag{$arch}});
1284 my @ignore_line = @option_ignore_line;
1285 # Ignore lines for this arch if requested.
1286 if ($arch and exists $option_ignore_arch_line{$arch}) {
1287 @ignore_line = (@ignore_line, @{$option_ignore_arch_line{$arch}});
1291 for (my $i = 0; $i < scalar @input; $i++) {
1292 my $line = $input[$i];
1294 # Ignore line if requested.
1295 foreach my $ignore (@ignore_line) {
1296 next LINE if $line =~ /$ignore/;
1300 if ($input_nonverbose[$i]
1301 and is_non_verbose_build($line, \$skip,
1302 \@input, $i, $parallel)) {
1303 if (not $option_buildd) {
1304 error_non_verbose_build($line, $input_number[$i]);
1305 $exit |= $exit_code{non_verbose_build};
1307 $statistics{commands_nonverbose}++;
1311 # Even if it's a verbose build, we might have to skip this line (see
1312 # is_non_verbose_build()).
1315 my $orig_line = $line;
1317 # Remove everything until and including the compiler command. Makes
1318 # checks easier and faster.
1319 $line =~ s/^.*?$cc_regex//o;
1320 # "([...] test.c)" is not detected as 'test.c' - fix this by removing
1321 # the brace and similar characters at the line end.
1322 $line =~ s/['")]+$//;
1324 # Skip unnecessary tests when only preprocessing.
1325 my $flag_preprocess = 0;
1332 # Preprocess, compile, assemble.
1333 if ($line =~ /\s(-E|-S|-c)\b/) {
1335 $flag_preprocess = 1 if $1 eq '-E';
1336 $compile = 1 if $1 eq '-S' or $1 eq '-c';
1337 # Dependency generation for Makefiles. The other flags (-MF -MG -MP
1338 # -MT -MQ) are always used with -M/-MM.
1339 } elsif ($line =~ /\s(?:-M|-MM)\b/) {
1341 # Otherwise assume we are linking.
1346 # -MD/-MMD also cause dependency generation, but they don't imply -E!
1347 if ($line =~ /\s(?:-MD|-MMD)\b/) {
1349 $flag_preprocess = 0;
1352 # Dependency generation for Makefiles, no preprocessing or other flags
1354 next if $dependency;
1356 # Get all file extensions on this line.
1357 my @extensions = $line =~ /$file_extension_regex/go;
1358 # Ignore all unknown extensions to speedup the search below.
1359 @extensions = grep { exists $extension{$_} } @extensions;
1361 # These file types don't require preprocessing.
1362 if (extension_found(\%extensions_no_preprocess, @extensions)) {
1365 # These file types require preprocessing.
1366 if (extension_found(\%extensions_preprocess, @extensions)) {
1367 # Prevent false positives with "libtool: link: g++ -include test.h
1368 # .." compiler lines.
1369 if ($orig_line !~ /$libtool_link_regex/o) {
1374 if (not $flag_preprocess) {
1375 # If there are source files then it's compiling/linking in one
1376 # step and we must check both. We only check for source files
1377 # here, because header files cause too many false positives.
1378 if (extension_found(\%extensions_compile_link, @extensions)) {
1379 # Assembly files don't need CFLAGS.
1380 if (not extension_found(\%extensions_compile, @extensions)
1381 and extension_found(\%extensions_no_compile, @extensions)) {
1383 # But the rest does.
1387 # No compilable extensions found, either linking or compiling
1390 # If there are also no object files we are just compiling headers
1391 # (.h -> .h.gch). Don't check for linker flags in this case. Due
1392 # to our liberal checks for compiler lines, this also reduces the
1393 # number of false positives considerably.
1395 and not extension_found(\%extensions_object, @extensions)) {
1400 my $compile_cpp = 0;
1401 my $restore_cflags = 0;
1402 # Assume CXXFLAGS are required when a C++ file is specified in the
1405 and extension_found(\%extensions_compile_cpp, @extensions)) {
1408 # Ada needs special CFLAGS
1409 } elsif (extension_found(\%extensions_ada, @extensions)) {
1410 $restore_cflags = 1;
1411 $preprocess = 0; # Ada uses no CPPFLAGS
1412 @cflags_backup = @cflags;
1413 @cflags = @cflags_noformat;
1415 } elsif (extension_found(\%extensions_fortran, @extensions)) {
1416 $restore_cflags = 1;
1417 @cflags_backup = @cflags;
1418 @cflags = @cflags_noformat;
1421 if ($option_buildd) {
1422 $statistics{preprocess}++ if $preprocess;
1423 $statistics{compile}++ if $compile;
1424 $statistics{compile_cpp}++ if $compile_cpp;
1425 $statistics{link}++ if $link;
1428 # Check if there are flags indicating a debug build. If that's true,
1429 # skip the check for -O2. This prevents fortification, but that's fine
1430 # for a debug build.
1431 if (any_flags_used($line, @def_cflags_debug)) {
1432 remove_flags([\@cflags], \%flag_renames, $def_cflags[1]);
1433 remove_flags([\@cppflags], \%flag_renames, $def_cppflags_fortify[0]);
1436 # Check hardening flags.
1438 if ($compile and (not all_flags_used($line, \@missing, @cflags)
1439 or (($harden_stack or $harden_stack_strong)
1440 and cflags_stack_broken($line, \@missing,
1441 $harden_stack_strong)))
1442 # Libraries linked with -fPIC don't have to (and can't) be
1443 # linked with -fPIE as well. It's no error if only PIE flags
1445 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1446 # Assume dpkg-buildflags returns the correct flags.
1447 and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
1448 if (not $option_buildd) {
1449 error_flags('CFLAGS missing', \@missing, \%flag_renames,
1450 $input[$i], $input_number[$i]);
1451 $exit |= $exit_code{flags_missing};
1453 $statistics{compile_missing}++;
1455 } elsif ($compile_cpp and not all_flags_used($line, \@missing, @cflags)
1456 # Libraries linked with -fPIC don't have to (and can't) be
1457 # linked with -fPIE as well. It's no error if only PIE flags
1459 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1460 # Assume dpkg-buildflags returns the correct flags.
1461 and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
1462 if (not $option_buildd) {
1463 error_flags('CXXFLAGS missing', \@missing, \%flag_renames,
1464 $input[$i], $input_number[$i]);
1465 $exit |= $exit_code{flags_missing};
1467 $statistics{compile_cpp_missing}++;
1471 and (not all_flags_used($line, \@missing, @cppflags)
1472 # The fortify flag might be overwritten, detect that.
1474 and cppflags_fortify_broken($line, \@missing)))
1475 # Assume dpkg-buildflags returns the correct flags.
1476 and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
1477 if (not $option_buildd) {
1478 error_flags('CPPFLAGS missing', \@missing, \%flag_renames,
1479 $input[$i], $input_number[$i]);
1480 $exit |= $exit_code{flags_missing};
1482 $statistics{preprocess_missing}++;
1485 if ($link and not all_flags_used($line, \@missing, @ldflags)
1486 # Same here, -fPIC conflicts with -fPIE.
1487 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie)
1488 # Assume dpkg-buildflags returns the correct flags.
1489 and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
1490 if (not $option_buildd) {
1491 error_flags('LDFLAGS missing', \@missing, \%flag_renames,
1492 $input[$i], $input_number[$i]);
1493 $exit |= $exit_code{flags_missing};
1495 $statistics{link_missing}++;
1499 # Restore normal CFLAGS.
1500 if ($restore_cflags) {
1501 @cflags = @cflags_backup;
1506 # Print statistics for buildd mode, only output in this mode.
1507 if ($option_buildd) {
1510 if ($statistics{preprocess_missing}) {
1511 push @warning, sprintf 'CPPFLAGS %d (of %d)',
1512 $statistics{preprocess_missing},
1513 $statistics{preprocess};
1515 if ($statistics{compile_missing}) {
1516 push @warning, sprintf 'CFLAGS %d (of %d)',
1517 $statistics{compile_missing},
1518 $statistics{compile};
1520 if ($statistics{compile_cpp_missing}) {
1521 push @warning, sprintf 'CXXFLAGS %d (of %d)',
1522 $statistics{compile_cpp_missing},
1523 $statistics{compile_cpp};
1525 if ($statistics{link_missing}) {
1526 push @warning, sprintf 'LDFLAGS %d (of %d)',
1527 $statistics{link_missing},
1530 if (scalar @warning) {
1531 local $" = ', '; # array join string
1532 print "$buildd_tag{flags_missing}|@warning missing|\n";
1535 if ($statistics{commands_nonverbose}) {
1536 printf "$buildd_tag{non_verbose_build}|%d (of %d) hidden|\n",
1537 $statistics{commands_nonverbose},
1538 $statistics{commands},
1550 blhc - build log hardening check, checks build logs for missing hardening flags
1554 B<blhc> [I<options>] I<< <dpkg-buildpackage build log file>.. >>
1558 blhc is a small tool which checks build logs for missing hardening flags. It's
1559 licensed under the GPL 3 or later.
1561 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
1562 tools using dpkg-buildpackage like pbuilder or sbuild (which is used for the
1563 official buildd build logs)) to help maintainers detect missing hardening
1564 flags in their packages.
1566 Only gcc is detected as compiler at the moment. If other compilers support
1567 hardening flags as well, please report them.
1569 If there's no output, no flags are missing and the build log is fine.
1571 See F<README> for details about performed checks, auto-detection and
1574 =head1 FALSE POSITIVES
1576 To suppress false positives you can embed the following string in the build
1579 blhc: ignore-line-regexp: REGEXP
1581 All lines fully matching REGEXP (see B<--ignore-line> for details) will be
1582 ignored. The string can be embedded multiple times to ignore different
1585 Please use this feature sparingly so that missing flags are not overlooked. If
1586 you find false positives which affect more packages please report a bug.
1588 To generate this string simply use echo in C<debian/rules>; make sure to use @
1589 to suppress the echo command itself as it could also trigger a false positive.
1590 If the build process takes a long time edit the C<.build> file in place and
1591 tweak the ignore string until B<blhc --all --debian package.build> no longer
1592 reports any false positives.
1600 Force check for all +all (+pie, +bindnow) hardening flags. By default it's
1603 =item B<--arch> I<architecture>
1605 Set the specific architecture (e.g. amd64, armel, etc.), automatically
1606 disables hardening flags not available on this architecture. Is detected
1607 automatically if dpkg-buildpackage is used.
1611 Force check for all +bindnow hardening flags. By default it's auto detected.
1615 Special mode for buildds when automatically parsing log files. The following
1616 changes are in effect:
1622 Print tags instead of normal warnings, see L</"BUILDD TAGS"> for a list of
1627 Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is
1632 Don't require Term::ANSIColor.
1636 Return exit code 0, unless there was a error (-I, -W messages don't count as
1643 Apply Debian-specific settings. At the moment this only disables checking for
1644 PIE which is automatically applied by Debian's GCC and no longer requires a
1645 compiler command line argument.
1649 Use colored (ANSI) output for warning messages.
1651 =item B<--line-numbers>
1653 Display line numbers.
1655 =item B<--ignore-arch> I<arch>
1657 Ignore build logs from architectures matching I<arch>. I<arch> is a string.
1659 Used to prevent false positives. This option can be specified multiple times.
1661 =item B<--ignore-arch-flag> I<arch>:I<flag>
1663 Like B<--ignore-flag>, but only ignore flag on I<arch>.
1665 =item B<--ignore-arch-line> I<arch>:I<line>
1667 Like B<--ignore-line>, but only ignore line on I<arch>.
1669 =item B<--ignore-flag> I<flag>
1671 Don't print an error when the specific flag is missing in a compiler line.
1672 I<flag> is a string.
1674 Used to prevent false positives. This option can be specified multiple times.
1676 =item B<--ignore-line> I<regex>
1678 Ignore lines matching the given Perl regex. I<regex> is automatically anchored
1679 at the beginning and end of the line to prevent false negatives.
1681 B<NOTE>: Not the input lines are checked, but the lines which are displayed in
1682 warnings (which have line continuation resolved).
1684 Used to prevent false positives. This option can be specified multiple times.
1688 Force check for all +pie hardening flags. By default it's auto detected.
1690 =item B<-h -? --help>
1692 Print available options.
1696 Print version number and license.
1700 Auto detection for B<--pie> and B<--bindnow> only works if at least one
1701 command uses the required hardening flag (e.g. -fPIE). Then it's required for
1702 all other commands as well.
1706 Normal usage, parse a single log file.
1708 blhc path/to/log/file
1710 If there's no output, no flags are missing and the build log is fine.
1712 Parse multiple log files. The exit code is ORed over all files.
1714 blhc path/to/directory/with/log/files/*
1716 Don't treat missing C<-g> as error:
1718 blhc --ignore-flag -g path/to/log/file
1720 Don't treat missing C<-pie> on kfreebsd-amd64 as error:
1722 blhc --ignore-arch-flag kfreebsd-amd64:-pie path/to/log/file
1724 Ignore lines consisting exactly of C<./script gcc file> which would cause a
1727 blhc --ignore-line '\./script gcc file' path/to/log/file
1729 Ignore lines matching C<./script gcc file> somewhere in the line.
1731 blhc --ignore-line '.*\./script gcc file.*' path/to/log/file
1733 Use blhc with pbuilder.
1735 pbuilder path/to/package.dsc | tee path/log/file
1736 blhc path/to/file || echo flags missing
1738 Assume this build log was created on a Debian system and thus don't warn about
1739 missing PIE flags if the current architecture injects them automatically (this
1740 is enabled in buildd mode per default). C<--arch> is necessary if the build
1741 log contains no architecture information as written by dpkg-buildpackage.
1743 blhc --debian --all --arch=amd64 path/to/log/file
1747 The following tags are used in I<--buildd> mode. In braces the additional data
1752 =item B<I-hardening-wrapper-used>
1754 The package uses hardening-wrapper which intercepts calls to gcc and adds
1755 hardening flags. The build log doesn't contain any hardening flags and thus
1756 can't be checked by blhc.
1758 =item B<W-compiler-flags-hidden> (summary of hidden lines)
1760 Build log contains lines which hide the real compiler flags. For example:
1767 Most of the time either C<export V=1> or C<export verbose=1> in
1768 F<debian/rules> fixes builds with hidden compiler flags. Sometimes C<.SILENT>
1769 in a F<Makefile> must be removed. And as last resort the F<Makefile> must be
1770 patched to remove the C<@>s hiding the real compiler commands.
1772 =item B<W-dpkg-buildflags-missing> (summary of missing flags)
1774 CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
1776 =item B<I-invalid-cmake-used> (version)
1778 By default CMake ignores CPPFLAGS thus missing those hardening flags. Debian
1779 patched CMake in versions 2.8.7-1 and 2.8.7-2 to respect CPPFLAGS, but this
1780 patch was rejected by upstream and later reverted in Debian. Thus those two
1781 versions show correct usage of CPPFLAGS even if the package doesn't correctly
1782 handle them (for example by passing them to CFLAGS). To prevent false
1783 negatives just blacklist those two versions.
1785 =item B<I-no-compiler-commands>
1787 No compiler commands were detected. Either the log contains none or they were
1788 not correctly detected by blhc (please report the bug in this case).
1794 The exit status is a "bit mask", each listed status is ORed when the error
1795 condition occurs to get the result.
1805 No compiler commands were found.
1809 Invalid arguments/options given to blhc.
1817 Missing hardening flags.
1821 Hardening wrapper detected, no tests performed.
1825 Invalid CMake version used. See B<I-invalid-cmake-used> under L</"BUILDD
1826 TAGS"> for a detailed explanation.
1832 Simon Ruderich, E<lt>simon@ruderich.orgE<gt>
1834 Thanks to to Bernhard R. Link E<lt>brlink@debian.orgE<gt> and Jaria Alto
1835 E<lt>jari.aalto@cante.netE<gt> for their valuable input and suggestions.
1837 =head1 LICENSE AND COPYRIGHT
1839 Copyright (C) 2012-2023 by Simon Ruderich
1841 This program is free software: you can redistribute it and/or modify
1842 it under the terms of the GNU General Public License as published by
1843 the Free Software Foundation, either version 3 of the License, or
1844 (at your option) any later version.
1846 This program is distributed in the hope that it will be useful,
1847 but WITHOUT ANY WARRANTY; without even the implied warranty of
1848 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1849 GNU General Public License for more details.
1851 You should have received a copy of the GNU General Public License
1852 along with this program. If not, see <http://www.gnu.org/licenses/>.
1856 L<hardening-check(1)>, L<dpkg-buildflags(1)>